PainJam/BaseGame
Archived
Template
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Brosef
2025-06-22 18:21:33 +01:00
parent 5a60777a73
commit 9c99027912
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -10,9 +10,19 @@ 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:
- `YourGame` (Based on [BaseGame](https://git.personal.imadumbass.dog/PainJam/BaseGame))
- [`GameUtils`](https://git.personal.imadumbass.dog/PainJam/GameUtils)
- [`NoPELib`](https://git.personal.imadumbass.dog/Brosef/NoPELib)
- [`PDOLib`](https://git.personal.imadumbass.dog/Brosef/PDOLib)
- [`PainJamLauncher`](https://git.personal.imadumbass.dog/PainJam/PainJamLauncher)
Once you have all of those, run `setup.py` located in the `PainJamLauncher`. This will automatically configure a virtual environment and install all dependancies.