Mythic GME Categories: End‑User Guide

Where the file lives

• Built‑in defaults: assets/meaning_tables/categories.json (read‑only)
• Your editable copy: {Documents}/meaning_tables/categories.json

File format overview

The file is standard JSON (no comments). It has two top‑level arrays:

• defaultCategories: Built‑in categories shipped with the app
• categories: Your custom categories

Category fields:

• id (string, required): Unique, kebab‑case. Example: character-identity
• displayName (string, required): Human‑readable name
• displayNameTranslations (object, optional): Map of locale codes to translated names
• iconKey (string, required): Font Awesome Pro Solid icon key
• sortOrder (integer, required): 0 = first; smaller shows earlier
• isBuiltIn (boolean, required): true for built‑in, false for user categories
• description (string, optional): What belongs in this category

Minimal example

{
  "defaultCategories": [
    {
      "id": "core-tables",
      "displayName": "Core Tables",
      "iconKey": "dice-d20",
      "sortOrder": 0,
      "isBuiltIn": true,
      "description": "Essential tables for core Mythic GME gameplay"
    }
  ],
  "categories": [
    {
      "id": "custom",
      "displayName": "Custom",
      "displayNameTranslations": { "pt": "Personalizado" },
      "iconKey": "circle-question",
      "sortOrder": 999,
      "isBuiltIn": false,
      "description": "User-created custom tables"
    }
  ]
}

Field details and constraints

id:

• Must be kebab‑case: lowercase letters, numbers, single hyphens only
• Cannot start/end with a hyphen or use consecutive hyphens
• Must be unique across all categories

displayName:

• Length: 1–80 characters

displayNameTranslations:

• Keys must be locale codes like en, pt, en-US

iconKey:

• Font Awesome Pro Solid key. Examples: dice-d20, user-large, wand-sparkles, dragon
• Tip: Use the in‑app icon picker to find valid keys
• Built‑ins may be overridden by the app's defaults based on id

sortOrder:

• Integer 0–999; lower numbers appear first

isBuiltIn:

• true for built‑in categories; false for your own
• Do not flip a built‑in from true → false (or vice versa)

description:

• Optional; up to ~300 characters recommended

Common tasks

Add a new category:

1. Create a new object under categories
2. Choose a unique kebab‑case id (e.g., my-worldbuilding)
3. Set isBuiltIn to false
4. Pick an iconKey via the app's icon picker
5. Pick a sortOrder (e.g., 500)

Reorder categories:

• Adjust sortOrder. Lower numbers appear earlier.

Localize display names:

• Add displayNameTranslations with keys like en, pt, en-US

Do's and Don'ts

Recovery and backups

If the file becomes invalid JSON, the app will:

• Create a backup at {Documents}/meaning_tables/invalidated-categories-<timestamp>.jsonc with an explanation
• Fall back to built‑in defaults so the app remains usable
• You can fix the JSON and restore, or reset to defaults from Settings

Validation

• A reference schema is available at docs/schemas/categories_schema.jsonc
• You can use external JSON validators or editor tooling mapped to that schema to validate your edits

Tips for icon keys

Examples that work well: dice-d20, user-large, wand-sparkles, dragon, people-group, book-open, masks-theater, eye, rocket, circle-question

The app ships a large set of icons; searching by name in the app is the easiest way to find and copy a valid key.