seppedl
a6fe624c5e
- Add README.md with install/run instructions using uv - Add build-system and script entry point to pyproject.toml - Add .gitignore for __pycache__ and save files - Remove placeholder main.py (entry point is h2g2.main:main) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
# The Hitchhiker's Guide to the Galaxy
|
|
|
|
A Python text adventure engine for the classic 1984 Infocom interactive fiction game, built from the original ZIL source code. The long-term goal is an accessible version for blind players via TTS/STT.
|
|
|
|
## Requirements
|
|
|
|
- Python 3.12+
|
|
- [uv](https://docs.astral.sh/uv/)
|
|
|
|
## Install & Run
|
|
|
|
```bash
|
|
# Clone the repo
|
|
git clone https://gitea.smashconsult.be/seppedl/h2g2.git
|
|
cd h2g2
|
|
|
|
# Install dependencies and run
|
|
uv run h2g2
|
|
```
|
|
|
|
Or install it into an environment:
|
|
|
|
```bash
|
|
uv pip install -e .
|
|
h2g2
|
|
```
|
|
|
|
You can also run it directly as a module without installing:
|
|
|
|
```bash
|
|
uv run python -m h2g2.main
|
|
```
|
|
|
|
## What's playable
|
|
|
|
The Earth opening sequence: wake up in your bedroom, find your gown and aspirin, make your way downstairs, head to the pub, and meet Ford Prefect.
|
|
|
|
## Project structure
|
|
|
|
```
|
|
h2g2/
|
|
engine/ # Core game engine (parser, object model, game loop)
|
|
content/ # Game content (rooms, objects, puzzles)
|
|
main.py # Entry point
|
|
*.zil # Original ZIL source code (Infocom, 1984)
|
|
docs/ # Original game manuals, maps, and story file (.z5)
|
|
```
|