intfic
| Crates.io | intfic |
| lib.rs | intfic |
| version | 0.3.8 |
| created_at | 2020-06-10 02:11:01.829003+00 |
| updated_at | 2020-07-10 23:24:25.831471+00 |
| description | An interactive fiction framework written in Rust |
| homepage | |
| repository | https://github.com/tjhaskel/rust_intfic |
| max_upload_size | |
| id | 252177 |
| size | 90,477 |
Trevan Haskell (tjhaskel)
documentation
README
intfic
intfic is a framework that allows you to write a branching story with minimal code. It uses story files with a custom markup syntax that allows for the following:
- Write text or specific quotes of text with different colors
- Display options that trigger different Story Blocks or Story Files
- Set flags or add to counters in the GameState
- Check flags or counters in the GameState and conditionally display text or options
Additionally, I've included some basic functions for asking yes-no questions and traveling in the cardinal directions, should you prefer to take a more "text adventure" approach with code.
Getting Started
- Run the example with "cargo run"
- Examine the example story files and read up on the intfic Story File Markup Specification
- Write you own story, and update main.rs to start it!
License
This project is licensed under the MIT License - see the LICENSE.md file for details