2 Commits
1.0.0 ... main

Author SHA1 Message Date
9c99027912 Updated README.md 2025-06-22 18:21:33 +01:00
5a60777a73 Added example launch.json 2025-06-22 18:15:25 +01:00
2 changed files with 28 additions and 1 deletions

17
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,17 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Python Debugger",
"type": "debugpy",
"request": "launch",
"python": "../PainJamLauncher/.venv/Scripts/python.exe",
"program": "../PainJamLauncher/__main__.py",
"args": ["CHANGE ME TO YOUR GAME ID"],
"console": "integratedTerminal"
}
]
}

View File

@ -10,9 +10,19 @@ This template contains the following files:
- `game.py`: Your actual game code. - `game.py`: Your actual game code.
- `game.toml`: Stores information about your game. - `game.toml`: Stores information about your game.
- `requirements.txt`: Base requirements each game needs. - `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: Make sure to edit / delete:
- `README.md`: To contain information about your game, rather than this. - `README.md`: To contain information about your game, rather than this.
- `TODO.md`: To contain your own TODOs. - `TODO.md`: To contain your own TODOs.
For more information about how to use each of these files, check the documentation within each file. 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.