Insufficient documentation/guide on multiplayer

The Multiplayer guide mentions that

All you need to do is add multiplayer: true to your client config object […] You can open multiple browser tabs and you will find that the game board is synced in realtime across all of them

Apparently, that’s not all that is needed. There’s some magic server code that needs to be written.

Furthermore, its not specified where exactly the code snippet with server.run(8000); is supposed to be put and how it can be executed. The same about the mention of Koa app.

I looked at the examples; multiple games and single/multi player modes are baked in a single app. Inferring the relevant parts from examples, to make just a multiplayer game for example, is difficult. Add to that the Koa and webpack config complexity that is in the examples but nowhere in the guide or documentation.

If the user is expected to already know certain things beforehand (obvious one being React.js) that may not be very obvious, list of such things should be documented.

[nicolodavis]

I’ve added a lot more detail in https://github.com/google/boardgame.io/commit/477aaf3a3dc97de361c2b2b5785b000562d55b58 (you can view them on the docs here). Let me know if these steps work for you!

The documentation looks a lot better now. Thanks for bringing this to my attention.

[Stefan-Hanke]

@viranch There are two gitter rooms, discussion takes place in the General one.