Introducing Relm, a Gameworld for Teamwork

canadaduane · April 14, 2020, 4:12am

I’ve been working on this project for a few months now, and wanted to introduce it to the Yjs community since we are now officially switched over to Yjs (and y-websocket) from statebus.

Relm, as it stands today, is the beginning of an effort to make collaborating online more like the fun and enjoyable experience in an online multiplayer world. You can visit the single player world here: https://relm.us or visit our predecessor world (on statebus) here: https://ayanarra.com

If you’re interested in multiplayer Relm, I can send you an invitation.

The project is open source and GPL3 licensed. Hopefully our use of Yjs might be helpful to others: https://github.com/relm-us/relm

Some source files relevant to Yjs implementation:

github.com

relm-us/relm/blob/e1129457055b19f8fbf2ab01eb376af660db14fc/src/new_network.js

import stampit from 'stampit'
import EventEmittable from '@stamp/eventemittable'

import * as Y from 'yjs'
import { WebsocketProvider } from 'y-websocket'

// const Y_URL = 'wss://y.relm.us'
// const Y_URL = 'ws://localhost:1235'
const Y_ROOM = 'relm'

const Network = stampit(EventEmittable, {
  props: {
    ydoc: new Y.Doc(),
    entityStates: null,
    invitations: null,
    provider: null,
    connected: false,
    // authorized: false,
  },

This file has been truncated. show original

github.com

relm-us/relm/blob/e1129457055b19f8fbf2ab01eb376af660db14fc/src/network_gets_state.js

import stampit from 'stampit'

import { Component } from './component.js'
import { stateToObject } from './state_to_object.js'

/**
 * SyncsStateWithAwareness syncs any data in the `state` deepProps of the Entity
 * to the Awareness system on the network.
 * 
 * The network 'Awareness' that we're talking about here is the yjs way of
 * telling us when a user is connected or disconnected, as well as transient
 * state information such as mouse pointer location or player location.
 * 
 * We use this transience as a speed boost and as a logical way of keeping
 * track of a lot of dynamic information that we don't actually care to
 * store anywhere (at least for now).
 */
const NetworkGetsState = stampit(Component, {
  props: {
    /**

This file has been truncated. show original

github.com

relm-us/relm/blob/e1129457055b19f8fbf2ab01eb376af660db14fc/src/network_sets_state.js

import stampit from 'stampit'

import { Component } from './component.js'

/**
 * SyncsStateWithAwareness syncs any data in the `state` deepProps of the Entity
 * to the Awareness system on the network.
 * 
 * The network 'Awareness' that we're talking about here is the yjs way of
 * telling us when a user is connected or disconnected, as well as transient
 * state information such as mouse pointer location or player location.
 * 
 * We use this transience as a speed boost and as a logical way of keeping
 * track of a lot of dynamic information that we don't actually care to
 * store anywhere (at least for now).
 */
const NetworkSetsState = stampit(Component, {
  props: {
    /**
     * The networkKey can be set to the type of object, e.g. 'player', so that

This file has been truncated. show original

We still have a long ways to go, but it’s exciting to see how simple it is to collaborate, even in a game world, using state synchronization and y-websocket.

dmonad · May 18, 2020, 8:36pm

This is so cool. I had some fun conversations with @canadaduane. Absolutely love this project!