freeboardgames/freeboardgames.org

FOSS platform for publishing boardgame.io games

FreeBoardGames.org

FOSS platform for publishing your boardgame.io games. We curate high quality implementations of board games and optimize your game for delivery so you can quickly reach thousands of players.

Play now at FreeBoardGames.org

Contributing

Check out our documentation and how to add your game.

Contributions are always welcome, even if just reporting bugs (check our issue tracker). Feel free to ask for any help!

Community

Running locally

git clone https://github.com/freeboardgames/FreeBoardGames.org
cd FreeBoardGames.org

yarn install  # installs dependencies

yarn run dev  # runs the webserver and backend (for online multiplayer games)

Important commands

yarn run dev GAME runs the development environment only for a given game.

yarn run test GAME runs unit tests and linter for given game.

yarn run lint GAME runs linter for given game.

yarn run fix GAME tries to automatically fix linter errors for given game.

yarn run ci on root runs everything CI will run (including e2e tests).

Omitting the GAME from any command above will run it for all the codebase.

Thanks to

Our amazing contributors

Sponsors

freeboardgames.org's Issues

Error: ENOENT: no such file or directory, open './dist/webpack/template.html'

I tried to clone this today and get it running but was unable to run yarn run dev. I was able to get it to run using yarn run prod, though. For context, I'm on Windows. Did I skip a step?

Repro steps:

• Clone repo
• CD into repo
• yarn install
• yarn run dev

Output:

$ webpack --progress --config dev.webpack.config.js; tsc; webpack --watch --progress --config dev.webpack.config.js | node dist/server.js
fs.js:119
    throw err;
    ^

Error: ENOENT: no such file or directory, open './dist/webpack/template.html'

Images broken when using app offline.

GameSharing: clipboard icon is on new row

Make sure service worker caching is working and single player modes are playable offline.

Better landing page

We should consider improving the landing page. The landing page has a lot of white space to the left/right of the content:

Analytics

Seabattle: Play sounds when hit or miss ship

Show arrow with last move in Chess

See example: https://nmrugg.github.io/kingdom/

Add Server Side rendering

Add option to share link using email, social networks and a button to copy to clipboard.

Avoid reloading app while navigating through its links.

Seabattle: i18n

Bug - Cant Make a Move - "move not processed"

When @jasonharrison was in the plane, we could not play together. I would make a move but he wouldn't see my move, and then if I relaod the page I would get the game state before my move, and would not be able to do the move again. Very weird.

This bug did not happen on Seabattle. I cannot reproduce this bug using my network connection using the same server (4G and wireless connection). Very weird.

I found this on the logs of the server, not sure if related:

ERROR: move not processed - canPlayerMakeMove=false, playerID=[1]
ERROR: move not processed - canPlayerMakeMove=false, playerID=[1]
ERROR: move not processed - canPlayerMakeMove=false, playerID=[1]
ERROR: move not processed - canPlayerMakeMove=false, playerID=[0]
ERROR: move not processed - canPlayerMakeMove=false, playerID=[0]
ERROR: move not processed - canPlayerMakeMove=false, playerID=[0]

Make app work offline and PWA

Add singleplayer mode to Chess

Use stockfish.js: https://github.com/nmrugg/stockfish.js (seems to be maintained)

Seabattle: Play a cool sound when the ship sinks. Fade it.

This will need to change the game logic to have a "sunk" property in each ship and salvo.

Create a blog post on how to add Tic Tac Toe to the platform.

Make sure app passes all PWA requirements and is installable.

Finish Seabattle UI

Automatic GA event tracking for all games.

[Infrastructure] Automatic notifications for the user when it is their turn so they can play.

Requisites

• If the user is already seing the screen, no need to beep/notify them.

Decrease build time

It is taking almost a minute to build and run the app on my machine. I think we can setup typescript and webpack better. I recommend taking inspiration on create-react-app.

Seabattle: Add other player screen on game end.

Probably a good idea to make the GameOver component receive an arbitrary component.

Migrate to immutable.js

Chess: Highlight squares for the last move.

Make victory/loss screen the same across games

Make chess playable offline

• Figure out how to allow downloading each game individually
• Make chess with Stockfish.js playable offline

Optimize webpack so each game load is independent of each other.

The user should only need to download the javascript of games they are about to play.

Redesign HUD

Better meta descriptions of pages for search

Better meta descriptions of pages for search

Migrate from Mongodb to Postgresql and sequelize

{{title}} as title

@flamecoals said this happened after changing the serviceworker

Make webpack faster, especially for file changes

Because looking at

gets boring.

Add about page

@flamecoals What should the about page contain? I'm thinking a link to the GitHub and contributor names -- what else?

Rename to freeboardgame.org

Robots.txt for hot/prod

Create lobby/nickname registration across the app.

Some requirements:

• User should be prompted for a nickname if it is their first time using that device.
• Users should know when each other is connected and ready to play.
• The game should automatically start after everybody is ready.
• We should store the logs of games for each player, so in the future we can do ranking and etc.
• Allow users to backup their account/game history with an email (nice to have).

Develop Colonizers UI

Warning: Material-UI: you are using the deprecated typography variants that will be removed in the next major release.

console.error node_modules/warning/warning.js:
Warning: Material-UI: you are using the deprecated typography variants that will be removed in the next major release.
Please read the migration guide under https://material-ui.com/style/typography#migration-to-typography-v2

Replay actions not seen by the user

Chess: i18n

Seabattle: Add single-player mode against bot

Make consistent loading/connecting user experience.

Develop colonizers rules

Chess: Add single-player mode, integrate with Stockfish.JS

DeprecationWarning: Tapable.plugin is deprecated. Use new API on `.hooks` instead

jason@mithos-h ~/p/FreeBoardGame.org:master> yarn run dev                                                                                                                   
yarn run v1.13.0                                                                                                                                                            
$ run-s build webpack:watch                        
$ tsc                                                                                                                                                                       
$ webpack --watch --progress --config dev.webpack.config.js
 10% building 0/0 modules 0 active          
webpack is watching the files…                           
                                                  
(node:18357) DeprecationWarning: Tapable.plugin is deprecated. Use new API on `.hooks` instead

Browser hanging when navigating out of Seabattle.

Add single player mode to games

Add sticky load balancing on nginx, Redis pub/sub

https://stackoverflow.com/questions/34217166/horizontally-scale-socket-io-with-redis

Migrate chess rules to chess.js