1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
//! This is a Rust port of inkle's [Ink](https://github.com/inkle/ink), a scripting language for writing interactive narratives.
//! `bladeink` is fully compatible with the reference version and supports all
//! its language features.
//!
//! To learn more about the Ink language, you can check [the official documentation](https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md).
//!
//! Here is a quick example that uses basic features to play an Ink story using
//! the `bladeink` crate.
//!
//! ```
//! # use bladeink::{story::Story, story_error::StoryError};
//! # fn main() -> Result<(), StoryError> {
//! # let json_string = r##"{"inkVersion":21, "root":["done",null],"listDefs":{}}"##;
//! # let read_input = |_:&_| 0;
//! // story is the entry point of the `bladeink` lib.
//! // json_string is a string with all the contents of the .ink.json file.
//! let mut story = Story::new(json_string)?;
//!
//! loop {
//! while story.can_continue() {
//! let line = story.cont()?;
//!
//! println!("{}", line);
//! }
//!
//! let choices = story.get_current_choices();
//! if !choices.is_empty() {
//! // read_input is a method that you should implement
//! // to get the choice selected by the user.
//! let choice_idx:usize = read_input(&choices);
//! // set the option selected by the user
//! story.choose_choice_index(choice_idx)?;
//! } else {
//! break;
//! }
//! }
//! # Ok(())
//! # }
//! ```
//!
//! The `bladeink` library supports all the **Ink** language features, including
//! threads, multi-flows, variable set/get from code, variable observing,
//! external functions, tags on choices, etc. Examples of uses of all these
//! features will be added to this documentation in the future, but meanwhile,
//! all the examples can be found in the `runtime/tests` folder in the source code
//! of this crate.