warchron_app/README.md

41 lines
887 B
Markdown
Raw Permalink Normal View History

2026-01-19 11:16:23 +01:00
# WarChron
2025-12-19 08:04:48 +00:00
2026-01-19 11:16:23 +01:00
A simple local app to track players' campaigns for tabletop wargames.
2025-12-19 09:56:45 +01:00
2026-01-15 12:43:40 +01:00
## Features
### Main logic
2025-12-19 09:56:45 +01:00
2026-01-19 11:16:23 +01:00
Manage a list of players to sign them up to be selectable for war(s) and campaign(s).
A "war" year contains several "campaign" events which contain several "battle" games organised in successive rounds.
Battle results determine campaign score which determines the war score.
Wars are independent.
2025-12-19 09:56:45 +01:00
2026-01-15 12:43:40 +01:00
### Design notes
2025-12-19 09:56:45 +01:00
2026-01-19 11:16:23 +01:00
* Players are global identities
* Influence tokens are scoped to a war
* Campaign order enables historical tie-breakers
* Effects are generic → future-proof
2026-01-15 12:43:40 +01:00
## Installation
### Requirements
- Python >= 3.12
- pip
### Setup
```bash
2026-01-19 11:16:23 +01:00
git clone <your-forge-address>/warchron_app.git
cd warchron_app
2026-01-15 12:43:40 +01:00
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -r requirements.txt
```
### Run
`python main.py`