- TypeScript 62.3%
- Lean 28.7%
- CSS 6%
- JavaScript 1.9%
- Shell 0.5%
- Other 0.6%
| .github | ||
| .vscode | ||
| client | ||
| cypress | ||
| doc | ||
| relay | ||
| server | ||
| .gitignore | ||
| cypress.config.ts | ||
| ecosystem.config.cjs | ||
| env.d.ts | ||
| LICENSE | ||
| NOTES.md | ||
| NOTES_SUBDOMAIN.md | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| TODO-skipped-commits.txt | ||
| tsconfig.json | ||
Lean 4 Game
This is the source code for the Lean Game Server hosted at adam.math.hhu.de.
Creating a Game
Please follow the tutorial Creating a Game. In particular, the following steps may be of interest:
- Step 6: How to Run Games Locally
- Step 8: How to Update an existing Game
- Step 10: How to Publish a Game
- Troubleshooting
Documentation
The documentation is very much work in progress but the links below should be up-to-date:
Game creation API
- Creating a Game: the main document to consult.
- More about Hints: describes the
HintandBranchtactics.
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 Publish a Game: load your game to adam.math.hhu.de for others to play
Backend
- Server: describes the server part (i.e. the content of
server/andrelay/).
Hosting
- How to host a lean4game instance yourself: how to set up your own Lean Game Server
Contributing
Contributions to lean4game are always welcome!
Check out the Development Instructions
Translation
We welcome translations of the game interface and of the various games hosted on the Lean Game Server into different languages!
- For translating the interface, please refer to these instructions.
- For translating individual games, please contact the maintainers (see table below) and consult any game specific translation guidelines. Our generic guidlines may give a rough indication of the steps involved.
- We also have some guidelines for game maintainers regarding translations.
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.
Contact
In case of a server outage at adam.math.hhu.de please open an issue and/or contact us by email. Bug reports and feature requests regarding the game interface should be filed on the issues page of this repository. For specific games on the Lean Game Server, please refer to the github repositories linked to below or contact the maintainers.
Credits
The project has primarily 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.