Skip to content

Template Guide

Rhys edited this page Dec 27, 2020 · 1 revision

If you are not interested/proficient in writing code, that's alright! There are plenty of arrays and places where we need writers, a list of which is accessible here.

The easiest way to contribute to the Generator is to fill the prompts in the Hivemind Creativity channels on our Discord server; these are simple prompts, that only require a sentence or so per entry. We do the rest of the work!

Grammar of the Generator

I am Australian. I use Australian English. Colour, not color. Please respect this, for the internal consistency of the tool.

Data Types

Arrays

If adding new arrays of random strings, please provide the context for its use in a comment like so.

condition: [
/** @example `The book is ______` */
'worn and tattered.',
'printed upside-down.',
'in good condition, but used. There are handwritten notes in the margins of the pages.'
]

If it is anticipated that its use will only be in one format (i.e. "Equal parts sticky and slimy, the alchemist's shop makes you feel as if you're being watched, and not in a good way."), then strings can include end marks (exclamation marks, full stops, and the like). Otherwise, if it is potentially used in many different ways (The elf's eyes are... ['blue', 'green', 'hazel']), then please omit end marks.

Threshold Tables

Threshold Tables are used in many different places, and are used in conjunction with a corresponding "roll", which is from 1-100. They are structured as an array of arrays, with the value being the first item in the array, and the descriptions being the second (and sometimes third, though you shouldn't worry about that). Roll tables look like this;

rolls: [
      /** @example `The room is ______` */
      [95, 'kingly'],
      [80, 'aristocratic'],
      [70, 'wealthy'],
      [60, 'comfortable'],
      [50, 'modest'],
      [25, 'poor'],
      [15, 'squalid'],
      [0, 'destitute']
]

You can safely add to threshold tables without fear of breaking anything!

Vignettes

Vignettes are short descriptions that are typically related to the environment. They do not present any opportunities for interaction from Players, and are solely for setting the feeling and mood of a scene.

Example of a vignette is bolded below, demonstrating how they fit into setting the scene.

This tactically sized citadel was built by an ambitious lady a few decades ago, and is perfectly maintained; upkeep has been fastidious. As you approach, a hint of brine and seaweed is carried by the wind to your nose. The citadel is known for never falling in a siege, and is worth defending because the tactical advantage of its position by the sea is incredibly important.

Existing arrays of vignettes can be added to freely- search for vignette and you'll find them.