Content System - localtoast9001/fantasy-framework-RPG GitHub Wiki

The content system is a common set of schemas and distribution formats that allow content developers to share and integrate game content.

The Content Object

The content object is the base class of all distributable content and describes a self-contained game entity, ex. an item, spell, monster, character class, race, adventure, or campaign module. Content must explicitly reference other dependent, but separate, content either in descriptions or in other schematized elements.

Common Attributes

  • Id - The unique identifier of the content. This is in GUID or UUID format.
  • Version - The version of the content in four part numeric format. Content can be revised to fix typos or other mistakes. This attribute tracks the specific revision.
  • Title - A friendly name that is used for informative purposes and can be displayed to a user instead of the Id. The language used for the name is not specified. The name is visible publically and can be searched by non-licensees.
  • Author - (optional) The author of the material in string format.
  • Date - (optional) The date the content was created.
  • CreativeCommonsAttribution - The CC license or public domain attribution in effect.
  • Description - The full description of the content in description mark-up. The language of the text is not specified. The description is only available to licensees.
  • Image - (optional) An image thumbnail for the content.

Description Mark-up

Description mark-up controls layout of the text description and can be interpreted for display on a console or browser. The content developer cannot assume fixed width fonts, specific line widths, margins, or spacing.

Like HTML, the format is divided into block and span elements. While descriptions can be transmitted in many formats, the formats have to transform to this format to be rendered universally. The basic grammar nodes are as follows:

  1. description :: block_type*
  2. block_type :: paragraph | table | unordered_list | ordered_list | blockquote
  3. paragraph :: span_type*
  4. table :: table_row*
  5. unordered_list :: list_element*
  6. ordered_list :: list_element*
  7. blockquote :: text
  8. span_type :: text | bold | italic | reference
  9. table_row :: table_cell*
  10. list_element :: block_type*
  11. bold :: span_type
  12. italic :: span_type
  13. reference :: Content Id with optional text for display
  14. table_cell :: cell | header
  15. cell :: block_type*
  16. header :: block_type*