Rewrite README to focus on game usage, remove personal content and license

This commit is contained in:
KansaiGaijin
2026-07-07 11:43:23 +12:00
parent f431ae8c53
commit db4b5cb543
2 changed files with 24 additions and 347 deletions

View File

@@ -1,13 +1,30 @@
# Kanjin-Text-RPG
An RPG text adventure game based of the Dungeons and Dragons SRD.
This game is being used as a learning experience for myself to practice code and learn by doing.
It started as a text only RPG, diverged into using QtPy5, then to Pygame with Pygame GUI and as of this point (15/01/2022) is back to text only but being rebuilt with the use of a game engine parsing map data as per ex. 43 of Zed Shaw's book 'Learn Python the Hard Way'.
A text adventure RPG based on the Dungeons & Dragons 5e SRD.
When running the code, make sure the pregen character is hashed out and you're running the startGame() function. If you're play testng, hash out this function and use a pregen to skip past character creation.
## Running
While still very much a large work in progress, I am comfortable with the direction the build is taking. Focusing mostly on getting the framework completed, the later steps will be to add more story and scenes, then finally to work on a bit more graphic design.
```bash
python main.py
```
Pure Python stdlib — no dependencies required.
## Playing
The game uses a directed graph of scenes with directional exits (north, south, east, west). Type `help` at any prompt for a full command list. Basic commands:
- `go [direction]` — move between scenes
- `look around` — see what's in the area
- `take [item]` / `loot [container]` — pick up items
- `examine [item]` — inspect an item
- `inventory` / `equipment` / `stats` — review your character
- `cast [spell]` / `rest` — spellcasting and recovery
## Character creation
Choose **"Create a new character"** for full creation with stat allocation, or **"Pre-Gen Character"** to pick one of three ready-to-play characters (Elven Wizard, Human Barbarian, Dwarven Cleric).
During playtesting, you can skip character creation by replacing `startGame()` in `main.py` with a pre-generated character and assigning stats directly (see `main.py:274-290` and `function_list.py:14-94`).
Taking many cues, pieces of advice, and explanation; this code is still 100% done and made by myself (Caveat: 29/10/2022 have brought in an Alex to assist.)
The code has no licence and as such is not free, is not available for modification, reduplication, sale, or any other use without explicit permission from myself.