Expand description
ยงepoch_forge CLI
The command-line interface for epoch_forge. It exposes a single
binary efo that supports the following sub-commands:
ยงSub-modules
epoch- switch / advance timeevent- add / remove eventschr- add / remove characterstown- add / remove townsblocker- add / remove blockerscalamity- add / remove calamitieslink- add / remove links (alliances, wars, roads, etc.)
Each sub-command is implemented in its own module under commands/.
The main.rs file simply parses arguments with clap and dispatches
to the appropriate handler. The handlers share a common World
instance that they load from / persist to disk.
Each module exposes a handle function that receives the parsed arguments
Modulesยง
- commands ๐
commandsmodule- error ๐
- General error type that the CLI propagates.
- success ๐
- List of all success messages possible
Structsยง
- Cli ๐
- The root command-line parser for the
efobinary.
Enumsยง
- TopLevel
Cmd ๐ - Enumeration of the top-level sub-commands that
efoaccepts.
Functionsยง
- exec_
dispatch ๐ - Dispatches the parsed command to the appropriate handler.
- main ๐
- Program entry point.