lean4game/doc/publish_game.md

Publishing games

You can publish your game on the official Lean Game Server in a few simple steps.

1. Upload Game to github

First, you need your game in a public Github repository and make sure the github action has run. You can check this by spotting the green checkmark on the start page, or by looking at the "Actions" tab.

2. Import the game

You call the URL that's listed under "What's Next?" in the latest action run. Explicitly you call the URL of the form

adam.math.hhu.de/import/trigger/{USER}/{REPOSITORY}

where {USER} and {REPOSITORY} are replaced with the github user and repository name.

You should see a white screen which shows import updates and eventually reports "Done."

3. Play the game

Now you can immediately play the game at adam.math.hhu.de/#/g/{USER}/{REPOSITORY}!

4. Update

To upload a new version of the game you will have to repeat 1. and 2. whenever you want to publish the updated version.

5. Main page

Adding games to the main page happens manually by the server maintainers. Tell us if you want us to add a tile for your game!

For example, you can contact Jon on Zulip. Or via Email.