Crate epkard

Epkard is a generalized framework for creating branching narratives.

Examples

Re-exports

pub use Interrupt::*;

Macros

paragraphs

A macro for creating sequential paragraph Nodes

Structs

CliFrontend

A frontend that uses stdin and stdout

ParagraphsExample

An example struct generated by the paragraphs! macro.

RunBuilder

A builder that runs the narrative when it is dropped

Runtime

Wraps the basic state with extra information and functionality

Enums

Color

Colors used for frontends

Interrupt

A type for non-continuous narrative flow.

RuntimeError

An error used by the Runtime

Traits

CommandNames

Trait for listing command names

Frontend

The frontend for a narrative that a user can interact with

Node

A story node in a narrative.

Functions

exit

Get an exit ControlResult

next

Get a next ControlResult with the given Node

run

Run the narrative starting at the given Node and state

run_default

Run the narrative starting at the default Node and state

Type Aliases

Control

A type for controlling narrative flow of nodes

ControlResult

A type for controlling narrative flow for non-node types

RuntimeResult

A Result type used by the Runtime

Derive Macros

Deserialize

Serialize