TemplateSchemas.md

Template Schema

Template files used by QuestWeaver use a JSON notation. This document shows how the template files for the quests and stories are structured.

Quest Template Files

<Document Content> =

{
  "parent": String,
  "key": String,
  "mandatory": [
    String
  ],
  "optional": [
    String
  ],
  "titles": [
    String
  ],
  "descriptions": [
    Description
  ],
  "objectives": [
    String
  ]
}

<String> = any valid JSON string (e.g. "Foo")

<Description>=

{
  "conditions": [
    String
  ],
  "text": String
}

Story Template Files

<Document Content> =

[
  Story
]

<String> = any valid JSON string (e.g. "Foo")

<Story>=

{
  "key": String,
  "required": [
    String
  ],
  "text": String
}

The "text" String has the following form:

Word word [mandatoryNugget] word [Nugget|NuggetOption:id] word {optionalNugget:id}

Story Nugget Files

<Document Content> =

[
  Nugget
]

<String> = any valid JSON string (e.g. "Foo")

<Nugget>=

{
  "key": String>
  "requiredTypes": [
    String
  ],
  "texts": [
    String
  ]
}