Skip to content

Category List

Wes Cook edited this page Oct 27, 2024 · 3 revisions

Category lists are JSON files that include categories and metadata to build bingo cards. An example of a valid list can be found here.

All keys are required unless listed as optional. Version 1 of the JSON format supports the following keys:

  • version: An integer value marking the version of the JSON format being loaded. Note: This is not the version of the category list itself.
  • name: A string representing the name of the list as shown during previews.
  • description: (Optional) A string offering a brief description of the list as shown during selection. HTML is not supported.
  • categories: An array of category objects, containing:
    • name: A string of the category name to be shown on bingo cards. Supports special tags for use as dynamic categories.
    • group: (Optional) A string of the group name. Used to discourage similar categories from generating together.
Clone this wiki locally