Add missing 'add_child' call in template and fix typos in docs

Author: ephread

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 Important changes to _inkgd_ will be documented in this file.
 
+## [0.4.X](https://github.com/ephread/inkgd/releases/tag/0.4.X)
+Released on 2022-0X-3X.
+
+### Fixed
+- Add missing `add_child` call in templates.
+
 ## [0.4.6](https://github.com/ephread/inkgd/releases/tag/0.4.6)
 Released on 2022-07-31.
 

addons/inkgd/editor/templates/ink_template.gd

@@ -21,6 +21,9 @@ onready var _ink_player = InkPlayer.new()
 # ############################################################################ #
 
 func _ready():
+%TS%# Adds the player to the tree.
+%TS%add_child(_ink_player)
+
 %TS%# Replace the example path with the path to your story.
 %TS%# Remove this line if you set 'ink_file' in the inspector.
 %TS%_ink_player.ink_file = load("res://path/to/file.ink.json")

addons/inkgd/editor/templates/ink_template_signals.gd

@@ -22,6 +22,9 @@ onready var _ink_player = InkPlayer.new()
 # ############################################################################ #
 
 func _ready():
+%TS%# Adds the player to the tree.
+%TS%add_child(_ink_player)
+
 %TS%# Replace the example path with the path to your story.
 %TS%# Remove this line if you set 'ink_file' in the inspector.
 %TS%_ink_player.ink_file = load("res://path/to/file.ink.json")

docs/source/advanced/choosing_between_inkgd_and_godot_ink.rst

@@ -21,7 +21,7 @@ instance, methods are written in PascalCase. Additionally, some types —such as
 InkList— can't be easily bridged to GDScript.
 
 *inkgd* provides a snake-cased API that integrates well with other GDScript
-scripts, but suffers from poor performances. The GDScript implementation is
+scripts but suffers from poor performance. The GDScript implementation is
 about 50 times slower than *godot-ink*. These performance limitations are
 detailed in :doc:`/advanced/performance`.
 

docs/source/advanced/differences_between_api.rst

@@ -60,7 +60,7 @@ InkRuntime contains a few configuration settings you may want to tweak, see the
 .. note::
 
     When using InkPlayer, you don't need to manually add the runtime node to
-    the tree. All the properties defined on InkRuntime also available on
+    the tree. All the properties defined on InkRuntime are also available on
     InkPlayer, use them instead if you did not instantiate the node by
     yourself.
 
@@ -203,14 +203,14 @@ information, refer to :doc:`this document</advanced/error_management>`.
     :ref:`exception_raised<class_inkruntime_exception_raised>`.
 
 
-Getting the ouput of ``evaluate_function``
+Getting the output of ``evaluate_function``
 ------------------------------------------
 
 ``evaluate_function`` evaluates an **ink** function from GDScript. Since it's
 not possible to have in-out variables in GDScript you need to pass ``true`` to
 ``return_text_output`` to retrieve the text output of the function.
 ``evaluate_function`` will then return a dictionary containing both the return
-value and the outputed text.
+value and the output text.
 
 .. code:: gdscript
 

docs/source/advanced/error_management.rst

@@ -50,7 +50,7 @@ Depending on the build type the runtime will behave differently.
      to the editor/terminal using ``push_error``;
 
    * if ``__InkRuntime.stop_execution_on_exception`` is ``true``, exceptions are reported using
-     ``assert`` instead, which pauses the execution and make them explicit.
+     ``assert`` instead, which pauses the execution and makes them explicit.
 
 #. This is a release build:
 

docs/source/advanced/migrating_to_godot_mono.rst

@@ -1,4 +1,6 @@
 Migrating to Godot Mono
 =======================
 
-To be added.
+To be added. In the meantime, see the example project and `story_player.gd`_.
+
+.. _`story_player.gd`: https://github.com/ephread/inkgd/blob/main/examples/scenes/common/story_player.gd

docs/source/advanced/performance.rst

@@ -22,7 +22,7 @@ Benchmarks
 The time required to create and allocate a story is benchmarked below.
 
 All benchmarks use variations of *ipsuminious*, a story based on the
-Intercept, which can replicate itself to artifically increase the number
+Intercept, which can replicate itself to artificially increase the number
 of words and constructs. The growth is linear. Size 12 is 12 times bigger than
 size 1.
 
@@ -172,7 +172,11 @@ Average novels contain about 90,000 words.
 Alternatives to *inkgd*
 -----------------------
 
-If *inkgd* proves too slow for you needs, the only other option is to migrate
-to Godot Mono and use the official C# implementation through `godot-ink`_.
+If vanilla *inkgd* proves too slow for your needs, there are two options
+involving Godot Mono.
+
+1. use the (undocumented) compatibility layer of inkgd, that exposes
+   the official C# implementation while keeping the same API;
+2. use the official C# implementation through `godot-ink`_.
 
 .. _`godot-ink`: https://github.com/paulloz/godot-ink

docs/source/advanced/using_inkplayer.rst

@@ -27,9 +27,9 @@ Main differences with *story.gd*
    the JSON bytecode.
 
 2. It unifies Ink's original handlers and *inkgd* custom signals under
-   a same set of consistent signals.
+   the same set of consistent signals.
 
-3. It adds convenience methods to save and load the story state.
+3. It adds convenient methods to save and load the story state.
 
 4. It simplifies certain APIs, such as
    :ref:`evaluate_function<class_inkplayer_evaluate_function>`
@@ -40,13 +40,12 @@ Main differences with *story.gd*
 Loop-based vs. signal-based flow
 --------------------------------
 
-InkPlayer can be used in two different ways. The examples below are
-incomplete, for a working example, refer to `the_intercept.gd`_.
+InkPlayer can be used in two different ways.
 
 .. warning::
 
-    The example below are not complete. For a working example, refer to
-    `the_intercept.gd`_.
+    The examples below are not complete. For a working example, refer to
+    `story_player.gd`_.
 
 
 Loop-based
@@ -130,7 +129,7 @@ more flexible.
         if !choices.empty():
             print(choices)
 
-            # In a real world scenario, _select_choice' could be
+            # In a real-world scenario, _select_choice' could be
             # connected to a signal, like 'Button.pressed'.
             _select_choice(0)
 
@@ -165,7 +164,7 @@ in code.
 |
 
 On platforms that don't support threads, the feature is automatically disabled
-regardles of the value of
+regardless of the value of
 :ref:`loads_in_background<class_inkplayer_loads_in_background>`.
 
 .. _`story_player.tscn`: https://github.com/ephread/inkgd/blob/main/examples/scenes/common/story_player.tscn

docs/source/classes/class_inkplayer.rst

@@ -90,7 +90,7 @@ Story Flow
 +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | void                                              | :ref:`choose_choice_index<class_inkplayer_choose_choice_index>`  **(** int_ index **)**                                                                              |
 +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                                              | :ref:`choose_path<class_inkplayer_choose_path>`  **(** String_ path_string **)**                                                                       |
+| void                                              | :ref:`choose_path<class_inkplayer_choose_path>`  **(** String_ path_string **)**                                                                                     |
 +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | void                                              | :ref:`switch_flow<class_inkplayer_switch_flow>`  **(** String_ flow_name **)**                                                                                       |
 +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -140,7 +140,7 @@ Variables
 +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | void                                              | :ref:`remove_variable_observer<class_inkplayer_remove_variable_observer>` **(** Object_ object, String_ method_name, String_ specific_variable_name **)**            |
 +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                                              | :ref:`remove_variable_observer_for_all_variables<class_inkplayer_remove_variable_observer_for_all_variables>` **(** Object_ object, String_ method_name **)**          |
+| void                                              | :ref:`remove_variable_observer_for_all_variables<class_inkplayer_remove_variable_observer_for_all_variables>` **(** Object_ object, String_ method_name **)**        |
 +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | void                                              | :ref:`remove_all_variable_observers<class_inkplayer_remove_all_variable_observers>` **(** String_ specific_variable_name **)**                                       |
 +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+