Help & Documentation => Designer Documentation => Topic started by: Freddy on August 23, 2021, 06:18:09 PM

Title: Designer - Key Tools
Post by: Freddy on August 23, 2021, 06:18:09 PM
Aside from the usual tools in a text editor, there are three key tools that are used for designing a page and adding markup.


Left to right: Action, Read More and Journal.

Action Tool

This is for adding core functions like turning pages, testing skills, testing variables, attacking enemies, taking things and so on. We call anything that the player can provoke by clicking on a piece of text an action.

To use the action tool you just need to select a portion of text and then click on the action tool icon. This will present the following dialog.


As you will see there are various options, these will be detailed elsewhere. You would proceed to fill in the various fields and submit it. This will tie it to that portion of text and when a player clicks on the text the appropriate action that you just set up will be made.

For this example I just elected to turn to a page when the player clicks on the portion of text. Once we click the submit button the editor will have inserted containing tags/mark up to identify the action text. To the right, a panel shows you all the actions you have entered on this page. Here it tells you that action #_0 will turn the page to a Failed Sanity page.


The designer allows you to find linked pages easily once you have added more pages. The 'Linked From' panel will later populate with any pages that link to this page.

And here is how this simple page and action will be rendered in game with one of our themes.


Read More Tool

This simply allows you to select a portion of text to be hidden until the player clicks on a read more link. You can only have one 'read more' on a single page. So just select the portion of text, click the Read More tool and then it will insert a special tag around it - the engine needs this to know what to do with it. All done.

Journal Tool

As the player progresses in the game the author can elect to save some commentary on their adventures. This will likely be key information and things the player might find useful to recall later. It probably won't be necessary to add journal entries to every page, but just as an aid to memory.

To add an entry to the journal just prepare a portion of text (on the page) that you would like to be the journal entry. Select it, then click on the Journal icon. This will surround the text with identifying tags. The engine will know, when the time comes that this is destined for the journal - it will not be shown on the actual game page.

In the game there will be a menu button to show the journal to the player.