Lean 4 Game

This is the source code for a Lean game platform hosted at adam.math.hhu.de.

Creating a Game

Please follow the tutorial Creating a Game. In particular, the following steps might be of interest:

• Step 5: How to Run Games Locally
• Step 7: How to Update an existing Game
• Step 9: How to Publishing a Game
• Troubleshooting

Documentation

The documentation is very much work in progress but the linked documentation here should be up-to-date:

Game creation API

• Creating a Game: the main document to consult.
• More about Hints: describes the Hint and Branch tactic.

Frontend API

• How to Run Games Locally: play a game on your computer
• How to Update an existing Game: update to a new lean version
• How to Publishing a Game: load your game to adam.math.hhu.de for others to play

Backend

not fully written yet.

• Server: describes the server part (i.e. the content of server/ und relay/).

Contributing

Contributions to lean4game are always welcome!

Translation

The interface can be translated to various languages. For adding a translation, one needs to do the following:

1. In client/src/config.json, add your new language. The "iso" key is the ISO language code, i.e. it should be accepted by "i18next" and "GNU gettext"; the "flag" key is once accepted by react-country-flag.
2. Run npm run translate. This should create a new file client/public/locales/{language}/translation.json. (alternatively you can copy-paste client/public/locales/en/translation.json)
3. Add all translations.
4. Commit the changes you made to config.json together with the new translation.json.

For translating games, see Translating a game.

Security

Providing the use access to a Lean instance running on the server is a severe security risk. That is why we start the Lean server with bubblewrap.

Credits

The project has pimarily been developed by Alexander Bentkamp and Jon Eugster.

It is based on ideas from the Lean Game Maker and the Natural Number Game (NNG) by Kevin Buzzard and Mohammad Pedramfar, and on Patrick Massot's prototype: NNG4.