epoch_forge/README.md

4.3 KiB

Epoch Forge

coverage version tests

Epoch Forge (efo) is an early-alpha command-line tool for managing a game's world or organisation across a sequence of snapshots called epochs. It is designed for people who are comfortable with Git-like concepts: inspect the current state, advance it, compare it with history, and deliberately discard a future timeline when needed.

The current release manages organisations, characters, towns, events, calamities, and blockers with statistics and relationships. After explicit migration, format 2 provides worktree/index staging, immutable commits, restore, conflict-safe revert, switching, and recoverable future pruning. A separate read-only TUI browses format-2 status and entities. Custom fields and TUI write workflows remain planned. There is no GUI or web interface.

Epoch Forge is not yet suitable as the only copy of important campaign data. Keep the repository in Git or make a directory backup before destructive operations. See Safety and recovery.

Install

The project currently requires Rust 1.92 or newer:

git clone https://proxy.dandaedre.com/gitea/idle-org/epoch_forge.git
cd epoch_forge
cargo install --locked --path bin_efo
cargo install --locked --path tui_efo

Nerd Font icons are enabled by default. Build a portable-Unicode variant for terminals without a Nerd Font with:

cargo install --locked --path bin_efo --no-default-features

Quick start

Start in an empty directory. Epoch Forge stores .epoch and epoch/ in the current working directory.

mkdir my-world
cd my-world
efo init

efo chr add "Aria" --stats strength:12 food:8
efo town add "Durn" --position 12,5
efo status
efo chr show Aria

# Snapshot the current state as the next epoch.
efo epoch summary "The expedition begins"
efo epoch tag beginning
efo epoch next

# Compare an entity after editing it in epoch 1.
efo chr edit Aria --prestige-add 2
efo chr diff Aria --epoch-id beginning
efo epoch log

Run efo --help, efo <command> --help, or see the command reference for the complete current interface.

Capabilities

Area Available now Not available yet
Repository Initialise; inspect; migrate/roll back; lock and recover transactional writes Discovery from child directories; integrity repair
Timeline Advance legacy epochs; format-2 commit, switch, log, tag, summarise, diff, restore, revert, and backed-up future pruning Branching and merging
Entities Add, edit, list, inspect, diff, and delete six built-in types Custom types and custom fields; bulk operations
Generation Generate character, town, event, calamity, blocker, and exotic names Deterministic seed controls and template packs
Interfaces Complete CLI; read-only efo-tui format-2 browser TUI write workflows; GUI/web (out of scope)

efo show all gives a world overview; per-type commands such as efo chr show Aria provide targeted or detailed inspection.

After migrating a repository to format 2, run efo-tui in its root. The TUI uses ordinary Unicode and text labels, so no meaning depends on Nerd Font glyphs. Press ? for its complete keyboard reference.

Documentation

Development

cargo fmt --all -- --check
cargo test --workspace --all-targets --all-features --locked
cargo clippy --workspace --all-targets --all-features --locked -- -D warnings

Tarpaulin and rust_autobadges are intentionally release-only. They do not run in routine CI because of their cost; badge files are refreshed for significant releases.

Release archives

The CLI package is efo in bin_efo. Release tags follow the Cargo version (for example v0.1.0). Cross-built archives are named efo-{target}-v{version}.tgz and are accompanied by SHA256SUMS.

Epoch Forge is licensed under the terms in LICENSE.