warchron_app/README.md

40 lines
937 B
Markdown
Raw Normal View History

2025-12-19 09:56:45 +01:00
# Wargame_campaign_app
2025-12-19 08:04:48 +00:00
2026-01-15 12:43:40 +01:00
A simple local app to manage players and their scores throughout several organised games of a tabletop wargame.
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
Manage a list of players to sign them up to be selectable for war(s) and campaign(s).
A year "war" 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.
2026-01-15 12:43:40 +01:00
### Design notes
2025-12-19 09:56:45 +01:00
Players are global identities
Influence tokens are scoped to a war
Campaign order enables historical tie-breakers
2026-01-15 12:43:40 +01:00
Effects are generic → future-proof
## Installation
### Requirements
- Python >= 3.12
- pip
### Setup
```bash
git clone <your-forge-address>/Wargame_campaign_app.git
cd Wargame_campaign_app
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -r requirements.txt
```
### Run
`python main.py`