If you actually want to contribute to this software, first off: Thanks! Sapling
+is just a side-project, unintended for any significant use.
+
+
Sapling is written in Ruby, and adheres to the standard Rubocop rules. So long
+as your code passes those rules, it should be good. At time of writing, Sapling
+has no testing, because I honestly have very little experience writing tests.
+Hopefully this changes soon!
+
+
If you don't know how to program in Ruby, but wish to improve this software,
+feel free to submit an issue or reach out to me directly.
+
+
Thanks again for your interest in Sapling!
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/file.LICENSE.html b/doc/file.LICENSE.html
new file mode 100644
index 0000000..6cdece4
--- /dev/null
+++ b/doc/file.LICENSE.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+ File: LICENSE
+
+ — Sapling Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the “Software”),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+
The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/file.README.html b/doc/file.README.html
new file mode 100644
index 0000000..1f05369
--- /dev/null
+++ b/doc/file.README.html
@@ -0,0 +1,141 @@
+
+
+
+
+
+
+ File: README
+
+ — Sapling Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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
+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 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.
+
+
You can experience this yourself, by loading "Example Quest! - A Meta Dialogue
+Tree!". You can find the tree itself at 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, or the self-documented configuration
+ file example. Alternatively, you can checkout
+Example Quest for a complete treel
The configuration file for sapling is a standard YAML file. The general
+outline looks something like this:
+
+
---
+ -
+ trunk: "This is a description of the dialogue tree."
+ -
+ branch:
+ number: 1
+ text: "This is the overall text for the branch."
+ leaf:
+ -
+ text: "This is option 1."
+ branch: 2
+ -
+ text: "This is option 2."
+ branch: 3
+ -
+ branch:
+ number: 2
+ text: "This is the overall text for the branch."
+ leaf:
+ -
+ text: "This is option 1."
+ branch: 1
+ -
+ text: "This is option 2."
+ branch: 3
+ -
+ branch:
+ number: 3
+ text: "This is the overall text for the branch."
+
+
+
Outline
+
+
Trunk
+
+
The trunk is a metadata list. Currently, the only information we really care
+about is a general description for the tree. Because of this, trunk is the
+key, and the description is the value.
+
+
Branch
+
+
Branches are the content of a dialogue tree. Each branch has the following
+options:
+
+
+
number: The branch number. This is how leaves get around. It must be unique.
+
text: The text provided by getting to this branch. The first branch is shown
+by default when the tree is opened.
+
leaf: [Optional] The list of options for the branch. Details for leaves are
+below. If no leaves are provided, the branch is considered a "terminal
+branch", and the program will end after reaching it.
+
+
+
Leaf
+
+
Leaves are the options of a branch. Each leaf has the following options:
+
+
+
text: The text shown as the option.
+
branch: The branch this option takes the user to.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/file.config_file_example.html b/doc/file.config_file_example.html
new file mode 100644
index 0000000..b1e305c
--- /dev/null
+++ b/doc/file.config_file_example.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+ File: Example YAML File
+
+ — Sapling Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
---
+# The trunk is a general introduction to the tree. It shouldn't include any
+# thematic details, rather a one-liner to let the user know what they're getting
+# into.
+-
+ trunk: "This is a general introduction to the dialogue tree."
+
+# Branches are the content of a dialogue tree. Each branch is numbered, and that
+# number is used as the primary means of navigation. The text of a branch is the
+# story provided to the user; the result of getting to the branch. The leaves
+# (the section titled leaf) represent the options. Options are displayed in the
+# order they appear. Within a leaf, the text is what the option says, and the
+# branch is the branch number which this option will lead to. Leading to branch
+# number 0 will immediately exit the program.
+#
+# You can have as many branches and leaves as you wish, though having too many
+# leaves may lead to both display problems, and paralyzing indecision.
+-
+ branch:
+ number: 1
+ text: "The first branch. Displayed first, by default."
+ leaf:
+ -
+ text: "The first option for this branch. It leads to branch 2"
+ branch: 2
+ -
+ text: "The second branch. It immediately exits the program."
+ branch: 0
+
+# A terminal branch is a branch which has no leaves. This represents an ending.
+# Once a user hits a terminal branch, the program will display the branch text,
+# and then redirect the user to branch 0, to exit.
+-
+ branch:
+ number: 2
+ text: "This is a terminal branch. After displaying this text,
+ the program will exit."
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/file.editor.html b/doc/file.editor.html
new file mode 100644
index 0000000..a87198b
--- /dev/null
+++ b/doc/file.editor.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+ File: Using the Editor
+
+ — Sapling Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Sapling provides an editor for creating and modifying dialogue trees. The editor
+allows for editing all parts of a tree, from the trunk to the leaves.
+
+
Creating a new tree
+
+
Pending
+
+
Editing an existing tree
+
+
Pending
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/file_list.html b/doc/file_list.html
new file mode 100644
index 0000000..edb69c0
--- /dev/null
+++ b/doc/file_list.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ File List
+
+
+
+
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
+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 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.
+
+
You can experience this yourself, by loading "Example Quest! - A Meta Dialogue
+Tree!". You can find the tree itself at 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, or the self-documented configuration
+ file example. Alternatively, you can checkout
+Example Quest for a complete treel