+Raconteur

+ +

Raconteur is a wrapper library for Undum, a system for writing hypertext +interactive fiction. Raconteur that to provide a more programmer-friendly +API as well as a bundle of commonly-needed functionality, for novices and +expert users alike.

+ +

Raconteur is still in active development towards its 1.0 release.

+ +

+Implemented Features

+ +

DSL-like syntax for defining situations.
A powerful situation prototype that bundles a lot of commonly-used +functionality.
Shorthand for defining common hypertext interactions such as text +replacement or insertion, similar to popular Twine extensions.
Most properties of situations can be either functions or strings, +making it easy to turn a simple situation into a complex one.
An interface that is specifically designed to be used with ECMAScript 6 via +Babel, or CoffeeScript.
Markdown, rather than raw HTML, as the format for most text content using +markdown-it.
A tool bundle of iterators that makes it easy to define adaptive text +snippets.
Based on CommonJS principles (Using undum-commonjs), allowing all game code +to be bundled using Browserify.

+ +

+Planned Features

+ +

An advanced game template that sets up a complete development environment +for authors: A build system (gulp), CSS preprocessing (Less), and dependency +management (Browserify + npm).
A complete code refactoring of Undum and Raconteur itself with testability +in mind, allowing the use of testing frameworks with Undum stories.

+ +

+Code examples

+ +

Those examples all use CoffeeScript.

+ +

Defining a simple situation in Raconteur:

+ +

situation 'raconteur_example',
+  content: """
+  This is an example of a situation using Raconteur's API. It supports
+  Markdown in text, so the content of a simple situation can just be
+  written out without explicit HTML.
+  """

+ +

Using text snippets:

+ +

+situation 'variations',
+  content: (character, system) ->
+    # content can be either a function or a simple string, transparently
+    color = oneOf(['bright purple', 'sickly green', 'brilliant white'])
+      .randomly(system) # We pass the system object so that random results
+                        # will always be the same across different runs of
+                        # the same saved game.
+
+    """
+      # Reflecting Pool
+
+      You find yourself in an underground, flooded cave. Light shimmers on
+      the walls, #{color}.
+    """

+ +

+Contributors

+ +

Undum was created by Ian Millington. Raconteur was written by Bruno Dias.

+ +

+License

+ +

In short: You can use, modify, or redistribute Raconteur and Undum, for any +purpose, as long as this license document is kept with copies of it. See +LICENSE for legalese.

+ +

+ + + +