first commit

README.md

@@ -0,0 +1,148 @@
+# Arcane Purge
+
+A text-based exorcist game where Bible verses are your weapons against demonic forces. Type verses from Scripture to cast spells, pass memory tests to defeat demons, and unlock progressively more powerful verses as you advance.
+
+## What It Does
+
+Arcane Purge is a terminal-based game that combines Scripture memorization with demon-slaying gameplay:
+
+- **Verse Casting** - Select a verse, then type it exactly to deal damage to demons. Verses matching a demon's weakness deal double damage.
+- **Memory Tests** - After a successful cast, recall the same verse without looking. Passing delivers a powerful finishing strike.
+- **Progression** - Start with 4 easy verses. Defeating demons unlocks harder verses and new categories. After 5 demons, Memory Mode activates.
+- **Scoring** - Points awarded for correct casts, speed bonuses, memory test success, and demon defeats. Deducted for failures.
+- **Hint System** - Press `H` at any input to see the first letter of each word.
+
+## Setup and Dependencies
+
+### Requirements
+
+- Python 3.11+
+- Astral UV (for dependency management)
+- Docker (for containerized deployment)
+
+### Install with UV
+
+```bash
+uv sync
+```
+
+This installs all dependencies listed in `pyproject.toml` (currently `pytest` for testing).
+
+### Install with pip
+
+```bash
+pip install pytest
+```
+
+## How to Run
+
+### Docker (Recommended)
+
+```bash
+cd docker
+docker compose up --build
+```
+
+This builds the game container and starts it in interactive mode. The game runs inside the container with a TTY attached for input.
+
+To run tests inside the container:
+
+```bash
+cd docker
+docker compose run game python -m pytest tests -v
+```
+
+### Direct Python
+
+```bash
+python main.py
+```
+
+### Running Tests
+
+```bash
+python -m pytest tests/ -v
+```
+
+The test suite includes 34 tests covering data loading, text normalization, verse filtering, similarity matching, hint generation, and game initialization.
+
+## Project Structure
+
+```
+exorcist-game/
+├── .dockerignore              # Docker build exclusions
+├── .env.example               # Environment variable template
+├── .hadolint.yaml             # Dockerfile linting config
+├── pyproject.toml             # Project metadata and dependencies
+├── uv.lock                    # UV dependency lock file
+├── verses.json                # Bible verse data (12 verses, 5 categories)
+├── data.py                    # Verse loading, filtering, text normalization
+├── main.py                    # Game engine: encounters, casting, scoring
+├── docker/
+│   ├── docker-compose.yml     # Service orchestration
+│   └── Dockerfile             # Multi-stage container build
+├── tests/
+│   ├── test_data.py           # Data module tests (21 tests)
+│   └── test_main.py           # Game logic tests (13 tests)
+└── README.md                  # This file
+```
+
+### Key Modules
+
+| File | Purpose |
+|---|---|
+| `main.py` | Game loop, demon encounters, verse casting, memory tests, scoring, progression |
+| `data.py` | Verse data loading from JSON, category/difficulty filtering, text normalization |
+| `verses.json` | 12 verses across 5 categories (Binding, Healing, Exorcism, Protection, Judgment) |
+| `tests/` | Validation suite ensuring data integrity and game logic correctness |
+
+## Configuration and Environment Variables
+
+### Environment Variables
+
+Copy `.env.example` to `.env` and configure:
+
+```bash
+PYTHON_VERSION=3.12-slim    # Python version for Docker base image
+GAME_PORT=8080              # (Reserved for future web interface)
+```
+
+The game runs without environment variables configured. All game data is embedded in `verses.json`.
+
+### Verse Data Format
+
+Each verse in `verses.json` follows this structure:
+
+```json
+{
+    "id": "binding_001",
+    "text": "Full verse text here.",
+    "category": "Binding",
+    "difficulty": 1,
+    "reference": "Luke 10:19"
+}
+```
+
+### Adding Verses
+
+Append new verse objects to the `verses` array in `verses.json`. Difficulty must be 1-5.
+
+### Adding Demons
+
+Edit the `DEMONS` list in `main.py`:
+
+```python
+{"name": "Demon Name", "health": 100, "weaknesses": ["Binding", "Exorcism"], "damage": 20}
+```
+
+### Code Quality
+
+The project uses Ruff for linting and Hadolint for Dockerfile validation:
+
+```bash
+ruff format .
+ruff check --fix .
+hadolint docker/Dockerfile
+```
+
+All checks must pass before building the container.