Skip to content

sillle14/lhog

Repository files navigation

Lewis' House of Games (LHoG)

A lobby implementation for games created using boardgame.io. This includes basic sign-in, persistent game storage (MongoDB), and a simple leaderboard. Any game written using boardgame.io can in theory be deployed here, although there are a few restrictions noted below.

Play at lhog.lewissilletto.com. Also, I've only tested the games with desktop Chrome, so your mileage may vary with other browsers/devices.

Games

Publishing Your Game to LHoG

As mentioned above, theoretically any game created with boardgame.io will fit into this lobby framework. I haven't tested any games other than my own, so there may be some bugs! If you are interested, publish your game to NPM and make a PR which adds your game to server.js and index.js.

In order to collect game statistics, there is one additional requirement. All games must report winning player IDs as {winnerIds: [1, ...]} on the endGame call, specified here. This allows the database layer to parse and save players who won the game.

Development

Run npm install to install the necessary packages. Run the server using npm run dev-server and the client using npm run dev. You'll also need a MongoDB running at port 27017.

Deployment

This is currently setup for deployment to Heroku with the server and client running at a single port. Run npm start to deploy.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages