This repository has been archived on 2026-02-27. You can view files and clone it, but cannot push or open issues or pull requests.
Files
BaseGame/README.md
2025-06-22 18:21:33 +01:00

1.4 KiB

BaseGame

The boilerplate code that all games are based on.

This makes it possible for the The Pain Jam Launcher to run your game properly.

Usage

This template contains the following files:

  • game.py: Your actual game code.
  • game.toml: Stores information about your game.
  • requirements.txt: Base requirements each game needs.
  • .vscode/launch.json: An example launch.json for use in VSCode. Change the arguments to use your game ID.

Make sure to edit / delete:

  • README.md: To contain information about your game, rather than this.
  • TODO.md: To contain your own TODOs.

For more information about how to use each of these files, check the documentation within each file.

In order to develop a game, you must base your game off this file, and require the following directory layout:

Once you have all of those, run setup.py located in the PainJamLauncher. This will automatically configure a virtual environment and install all dependancies.