Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
prosif authored Mar 18, 2024
1 parent a4b4b04 commit e2fb1a2
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Requirements:
- Node.js >= 18

```
npm i
npm install
node index.js
```

Expand Down Expand Up @@ -62,8 +62,11 @@ A game session (`src/GameSession.js`) will run a `Game` on a given port. It hand

The game session is responsible for:
- Instantiating a `HomegamesRoot` which is responsible for stuff like the Homegames frame
- src/homegames_root
- Creating a `Squisher` and notifying players when updates occur
- The squisher comes from our game library - [squishjs](https://github.com/homegamesio/squish)
- It's responsible for serializing ("squishing") game state.
- Managing player connections to the session

## Homenames
Homenames is an HTTP API that runs alongside a Homegames core instance. It is responsible for maintaining user metadata (eg. name, settings) across game sessions. It maintains a map of player IDs to player names and settings, allowing clients to say "hey I'm player ID x" and a session can say "I know you, you're booty slayer".
Homenames is an HTTP API that runs alongside a Homegames core instance. It is responsible for maintaining user metadata (eg. name, settings) across game sessions. It maintains an in-memory map of player IDs to player names and settings. This allows a client to say "hey I'm player ID x" and a game session can say "I know you, you're booty slayer and you want sound muted."

0 comments on commit e2fb1a2

Please sign in to comment.