epoch_forge/README.md

67 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 📦 Epoch Forge (`epoch_forge`)
> **A Rust‑powered CLI for managing fantasy organisations across time.**
> *Think of it as a living, breathing world‑state engine that lets you “rewind”, “fast‑forward”, and **alter** the history of guilds, towns, wars, and characters.*
> 🚀 *Fast, type‑safe, and fully testable.*
---
## ✨ Quick start
```bash
# clone the repo
git clone https://github.com/yourname/epoch_forge.git
cd epoch_forge
# build the binary
cargo build --release
# initialise an empty world (epoch 0)
./target/release/efo epoch --init
# add a guild
./target/release/efo org add --name "The Iron Horde" --leader "Gorun"
# add a town
./target/release/efo town add --name "Durn" --population 350
# create an alliance
./target/release/efo link add --type alliance --org "Iron Horde" --town "Durn"
# advance the timeline
./target/release/efo epoch --advance 3
# inspect the world
cat world.json
```
## 🏆 Project Highlights
| Feature | What it gives you | Where it lives |
|---------|------------------|----------------|
| **Epoch management** | Switch, advance, or rewind the timeline | `core::epoch` |
| **Event handling** | Add/remove world‑shaping events (storms, festivals, wars) | `core::event` |
| **Organisation CRUD** | Guilds, factions, corporations | `core::org` |
| **Character CRUD** | Heroes, villains, NPCs | `core::character` |
| **Town CRUD** | Villages, cities, trade hubs | `core::town` |
| **Link network** | Alliances, wars, roads, trade routes | `core::link` |
| **Persistence** | JSON/YAML stores, pluggable back‑ends | `core::storage` |
| **CLI** | `efo` binary with sub‑commands | `efo` crate |
| **Tests** | Unit & integration coverage | `tests/` |
---
### 📃 Quick reference table
| Sub‑command | Usage | What it changes |
|-------------|-------|-----------------|
| `epoch` | `efo epoch --init`<br>`efo epoch --advance N`<br>`efo epoch --target ID` | Creates a world; moves time forward or back. |
| `event` | `efo event add ...`<br>`efo event remove ...` | Adds or removes an event. |
| `org` | `efo org add ...`<br>`efo org remove ...` | Manages guilds/factions. |
| `chr` | `efo chr add ...`<br>`efo chr remove ...` | Handles characters. |
| `town` | `efo town add ...`<br>`efo town remove ...` | Town CRUD. |
| `link` | `efo link add ...`<br>`efo link remove ...` | Relations: alliances, wars, roads, trade. |
Happy forging! 🔨✨