vagabond/sapling
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

README.md: Update to most current correct info

Browse source
This commit is contained in:
Bill Niblock 2017-05-06 15:39:33 -04:00
parent d02bf204cc
commit 562aeb2437
1 changed files with 39 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -1,6 +1,6 @@
# Dialogue Tree CLI Tool
# Sapling: A Dialogue Tree CLI Utility
This tool allows for easy creation and use of dialogue trees.
Sapling allows for easy creation and use of dialogue trees.
A dialogue tree is a series of dialogues which follow sequentially, though with
branching options. Examples include "Choose Your Own Adventure" games, or the
@ -9,32 +9,59 @@ dialogues seen in many video games.
## Structure
A dialogue tree can be broken down into three distinct parts: the trunk,
branches, and leafs. The trunk is the beginning of the dialogue. Generally
speaking, it is a branch, with the exception that it has no previous options. A
branches, and leafs. The trunk represents the main structure of the tree. Unlike
a branch, which displays content and options, the trunk provides metadata.
Generally speaking, it is a branch, with the exception that it has no options. A
branch represents a choice taken in the dialogue. Branches flow to each other
through leafs, which are the actual choices. A leaf is a data point, allowing
for specific configuration of what information gets passed to the next branch,
or even an end to the entire tree.
through leafs, which are the actual choices.
You can experience this yourself, by loading "Example Quest! - A Meta Dialogue
Tree!". You can find the tree itself at [trees/example\_quest.yaml](
trees/example_quest.yaml). To run it, just type `sapling -t
trees/example_quest.yaml`.
## Building a New Tree
To build a new tree, you have two options. You can manually edit a configuration
file, or go through the construction wizard. Either way, the end result is a
plain-text configuration file, which can be easily shared, edited, and viewed.
For more details on the configuration file itself, check out the [Configuration
File documentation](docs/config_file.md), or the self-documented [configuration
file example](docs/config_file_example.yaml). Alternatively, you can checkout
[Example Quest](trees/example_quest.yaml) for a complete treel
### Manual Edit
1. Open your preferred text editor.
2. Refer to the Configuration File documentation (docs/config\_file.md)
2. Refer to the [Configuration File documentation](docs/config_file.md)
3. Make your changes.
4. Save your changes.
### Automatic Edit
### Automatic Edit -- Coming Soon(tm)!
1. Run the configuration editor: `sapling --editor [--new][--file FILE]`
1. Run the configuration editor: `sapling --edit [--new][--file FILE]`
2. If you choose to create a new dialogue, `sapling` will generate a new file in
your current directory.
3. If you choose to modify an existing file, `sapling` will show you the basic
overview of the tree, and prompt you where you wish to edit.
3. If you choose to modify an existing file, `sapling` will open the tree at the
trunk, and show you the first branch.
4. Make your changes.
5. Save your changes.
More details on the editor can be found in the [Editor
documentation](docs/editor.md).
## Contributing
You can contribute to Sapling by following these instructions:
1. Fork this repository.
2. In your fork, make your changes.
3. Make sure your changes respect the [contribution
guidelines](CONTRIBUTING.md).
4. Submit a pull request.
## License
Sapling is licensed under the MIT license. The full text can be found in
[LICENSE](LICENSE).
(c) 2017 Bill Niblock