Skip to content

Publish a Pygame game

All engines

Pygame games run in the browser with pygbag. ThrunGames does not detect Pygame, so set the engine yourself.

Build with pygbag

  1. Install it: pip install pygbag.
  2. Make sure your game folder has a main.py at its top level, and that its main loop is async and calls await asyncio.sleep(0) each frame, as the pygbag documentation describes.
  3. Build: pygbag --build your-game-folder.

pygbag writes the web build to build/web inside your game folder. That folder holds the index.html and an .apk file.

What to zip

Zip the contents of build/web. Do not zip the whole game folder.

Zip and upload

Zip the contents of the export folder, so that index.html is at the root of the zip. Do not zip the folder itself. If index.html ends up inside a folder, the upload fails and tells you so.

Your game has to exist before you upload. If you have not made it yet, sign in, open My games and choose "Add new game". (You need a developer account: see Become a developer.) Note the game's slug, the last part of its address.

Then upload with the ThrunGames CLI:

thrungames login
thrungames upload path/to/export-folder --game <your-game-slug> --version 1.0.0 --width 960 --height 600 --submit

--width and --height are the size of the game's play area in pixels on a Classic game page; an Immersive game fills the screen and ignores them.

The CLI zips the folder for you. You can also point upload at a .zip file you made yourself. Leave out --submit to keep the upload as a draft with a preview link. To skip the flags next time, put a game.json with name, version, width and height in the folder (see the CLI page).

The limits are 450 MB for the zip through the CLI (100 MB on the website), 500 MB unpacked, and 5000 files.

Engine and layout

ThrunGames detects the engine when you upload and sets it on your game if you have not set one. ThrunGames does not detect this engine on its own, so set it yourself. To change it later, use the game settings, or:

thrungames games edit <game> --engine pygame
thrungames games edit <game> --layout classic