KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

relm-v4

★ 34 Open GitHub ↗

Relm is a browser-based world that makes "virtual locality" possible--providing a way to be together with friends online in a community that meets more of our universal human needs than today's social networks do.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Relm

## Installing for Local Development

You can get going pretty quickly if you have a nodejs environment set up. You will need 2 server processes for basic multiplayer:

Browser client dev server:
```
yarn install
yarn start
```

Data sync server (yjs):
```
cd server
yarn install
yarn start
```

We recommend node 10.21.0 at the time of this writing.

## Project Structure

The Relm engine uses a loose ECS (entity-component-system) style of code organization. We're using [stampit](https://stampit.js.org/) as a way to create Components that interact with each other when added to an Entity.

If you want to get started understanding the code, check out `src/index.html`.

Project structure:

```
dist   - ephemeral directory, not part of git. Build artifacts go here.
public - assets that are loaded at run-time, e.g. images, meshes, animations
server - source code for the yjs data sync & websocket server
src    - source code for the browser-based game client
\- lib - pieces of sample code and external libraries we've modified.
```

relm-v4

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README