Skip to content

Category List

Jump to bottom
Wes Cook edited this page Apr 17, 2025 · 7 revisions

Category lists are JSON files that include categories and metadata to build bingo cards. Examples of valid files can be found here, while the precise schema can be found here. Each key is briefly described below.

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.
  • gamerules: (Optional) An object that provides default values for game rules when loading from a category list. These values are not restricted, and must be valid for the specified game rule. The schema includes expected types and enum values.
    • winCondition: An example of a supplied game rule. More can be found in the schema above or game rules page.
  • 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