events.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Critical Path Game Events Schema",
  "description": "Schema for validating events.json in the Critical Path AI strategy game",
  "type": "object",
  "properties": {
    "specialEvents": {
      "type": "object",
      "description": "Special events that trigger under specific conditions",
      "patternProperties": {
        "^[a-z-]+$": {
          "$ref": "#/definitions/specialEvent"
        }
      },
      "additionalProperties": false
    },
    "safetyIncidents": {
      "type": "object",
      "description": "Safety incident event template",
      "properties": {
        "type": {
          "type": "string",
          "const": "safety-incident"
        },
        "title": {
          "type": "string",
          "minLength": 1,
          "description": "Short title for the event"
        },
        "weight": {
          "type": "number",
          "minimum": 0
        },
        "text_versions": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "minItems": 1
        }
      },
      "required": ["type", "weight", "text_versions"],
      "additionalProperties": false
    },
    "defaultEvents": {
      "type": "array",
      "description": "Default events that can occur during gameplay",
      "items": {
        "$ref": "#/definitions/defaultEvent"
      }
    }
  },
  "required": ["specialEvents", "safetyIncidents", "defaultEvents"],
  "additionalProperties": false,
  "definitions": {
    "specialEvent": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^[a-z-]+$"
        },
        "title": {
          "type": "string",
          "minLength": 1,
          "description": "Short title for the event"
        },
        "text_versions": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "minItems": 1
        },
        "choices": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/choice"
          },
          "minItems": 1
        },
        "other_texts": {
          "$ref": "#/definitions/otherTexts"
        },
        "customHandler": {
          "type": "string",
          "description": "Name of the custom handler function for this event"
        }
      },
      "required": ["type", "text_versions", "choices"],
      "additionalProperties": false
    },
    "defaultEvent": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^[a-z-]+$",
          "description": "Unique identifier for the event type"
        },
        "title": {
          "type": "string",
          "minLength": 1,
          "description": "Short title for the event"
        },
        "weight": {
          "type": "number",
          "minimum": 0,
          "description": "Probability weight for event selection (0 = disabled)"
        },
        "oneTimeAccept": {
          "type": "boolean",
          "description": "Whether this event can only occur once if accepted"
        },
        "maxTimes": {
          "type": "number",
          "minimum": 1,
          "description": "Maximum number of times this event can occur regardless of choice"
        },
        "requires": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z-]+$"
          },
          "description": "List of event types that must be accepted before this event can occur"
        },
        "aiLevelRange": {
          "$ref": "#/definitions/aiLevelRange"
        },
        "customHandler": {
          "type": "string",
          "pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
          "description": "Name of custom JavaScript function to handle this event"
        },
        "text_versions": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "minItems": 1,
          "description": "Array of possible text variations for this event"
        },
        "other_texts": {
          "$ref": "#/definitions/otherTexts"
        },
        "choices": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/choice"
          },
          "minItems": 1,
          "description": "Available choices for the player"
        }
      },
      "required": ["type", "weight", "text_versions"],
      "additionalProperties": false
    },
    "aiLevelRange": {
      "type": "object",
      "description": "AI level constraints for when this event can occur",
      "properties": {
        "min": {
          "type": "number",
          "minimum": 0,
          "description": "Minimum AI level required for this event"
        },
        "max": {
          "type": "number",
          "minimum": 0,
          "description": "Maximum AI level allowed for this event"
        }
      },
      "additionalProperties": false,
      "anyOf": [
        {"required": ["min"]},
        {"required": ["max"]},
        {"required": ["min", "max"]}
      ]
    },
    "otherTexts": {
      "type": "object",
      "description": "Additional text content for multi-stage events or outcome variations",
      "patternProperties": {
        "^[a-z_]+$": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "choice": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string",
          "minLength": 1,
          "description": "Display text for this choice"
        },
        "action": {
          "type": "string",
          "pattern": "^[a-z-]+$",
          "description": "Action type for this choice (accepts custom actions for events with customHandler)"
        },
        "condition": {
          "type": "string",
          "pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
          "description": "Boolean gameState variable that must be true for this choice to appear"
        },
        "hotkey": {
          "type": "string",
          "enum": ["enter"],
          "description": "Keyboard shortcut for this choice"
        },
        "cost": {
          "$ref": "#/definitions/resourceCost"
        },
        "benefit": {
          "$ref": "#/definitions/resourceBenefit"
        },
        "penalty": {
          "$ref": "#/definitions/resourcePenalty"
        },
        "risk": {
          "$ref": "#/definitions/resourceRisk"
        },
        "result_text": {
          "type": "string",
          "minLength": 1,
          "description": "Text to display after choosing this option"
        }
      },
      "required": ["text", "action"],
      "additionalProperties": false
    },
    "resourceCost": {
      "type": "object",
      "description": "Resources that will be deducted when this choice is taken",
      "properties": {
        "money": {
          "type": "number",
          "minimum": 0
        },
        "diplomacyPoints": {
          "type": "number", 
          "minimum": 0
        },
        "productPoints": {
          "type": "number",
          "minimum": 0
        },
        "safetyPoints": {
          "type": "number",
          "minimum": 0
        }
      },
      "additionalProperties": false
    },
    "resourceBenefit": {
      "type": "object",
      "description": "Resources or bonuses gained when this choice is taken",
      "properties": {
        "incomeBonus": {
          "type": "number",
          "minimum": 0,
          "description": "Permanent income increase per turn"
        },
        "aiLevelPerTurn": {
          "type": "number",
          "minimum": 0,
          "description": "AI level increase per turn"
        },
        "resourceMultiplier": {
          "type": "number",
          "minimum": 1,
          "description": "Multiplier for all monthly resources"
        },
        "diplomacyMultiplier": {
          "type": "number",
          "minimum": 1,
          "description": "Multiplier for diplomacy gains"
        },
        "productMultiplier": {
          "type": "number",
          "minimum": 1,
          "description": "Multiplier for product development gains"
        },
        "activateTechnology": {
          "type": "string",
          "description": "Technology ID to activate when this benefit is applied"
        }
      },
      "additionalProperties": false
    },
    "resourcePenalty": {
      "type": "object", 
      "description": "Guaranteed negative effects when this choice is taken",
      "properties": {
        "riskLevel": {
          "type": "number",
          "minimum": 0,
          "description": "Increase to risk level"
        },
        "sanctions": {
          "type": "boolean",
          "description": "Triggers economic sanctions"
        },
        "statusEffect": {
          "type": "string",
          "description": "Name of status effect to apply (e.g., 'disillusioned', 'under-investigation')"
        }
      },
      "additionalProperties": false
    },
    "resourceRisk": {
      "type": "object",
      "description": "Probability-based negative effects when this choice is taken",
      "properties": {
        "sanctions": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "description": "Probability (0-1) of triggering sanctions"
        },
        "statusEffect": {
          "type": "object",
          "description": "Probability-based status effect",
          "properties": {
            "name": {
              "type": "string",
              "description": "Name of the status effect"
            },
            "probability": {
              "type": "number",
              "minimum": 0,
              "maximum": 1,
              "description": "Probability (0-1) of triggering this status effect"
            }
          },
          "required": ["name", "probability"],
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  }
}