From 9c9902791212c68908c4e635947f3cf03b343fd0 Mon Sep 17 00:00:00 2001 From: Brosef Date: Sun, 22 Jun 2025 18:21:33 +0100 Subject: [PATCH] Updated README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 552e9f8..1ab335d 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of 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. \ No newline at end of file