View Source API Reference DevJoy v1.0.0
Modules
A character is an NPC acting in a game.
An example character's data module which fetches forum data using username and Discourse API. It uses only publicly available data which does not requires any authentication.
Scene defines DSL which stores scene parts within get_part/0
and get_part/1
function.
Asset gives a way to display an image, play a sound or work with any other files. Data allows to configure how the asset should be used. For example the same image may be displayed as a background or inside an image preview popup. The sounds on the other side could be repeated. Other files or even directories could be used to show a gallery or open it in external application.
Challenge is a polimorfic custom content specific for your game. It could be a mini-game or other custom action user have complete to progress in game.
Choice visually presented as button gives user a possibility to apply an action. It could be a simple menu item as well as an answer for a character question. Returned data may be used to perform a further changes in UI.
A dialog visually represented in dialog box contains a text to be displayed. Dialog have an optional choices which allows for example to answer a character's question. Dialog allows to display the character information on opposite side. This adds a bit of flexibility for UI design, so dialogs could be styled as messages in chat application.
Menu visually represented as a titled list of buttons allows to navigate between scenes and their parts.
A part may be used to split a long scene or adding an alternative scenario.