isaacscript/schemas/isaacscript-schema.json

A command line tool for managing Isaac mods written in TypeScript.

{
  "$ref": "#/definitions/Config",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "Config": {
      "additionalProperties": false,
      "description": "This is the format for the \"isaacscript.json\" file.",
      "properties": {
        "$schema": {
          "type": "string"
        },
        "customTargetModDirectoryName": {
          "description": "By default, the target mod directory name will be the same as the project directory name. This setting allows you to customize it.",
          "type": "string"
        },
        "enableIsaacScriptWatcherAutoRestart": {
          "description": "When your code is recompiled, IsaacScript watcher can restart the game to ensure that any run-related variables are properly reset. This is set to true by default.",
          "type": "boolean"
        },
        "isaacScriptCommonDev": {
          "description": "If set to true, the IsaacScript watcher will spawn an additional watcher process for the files in the `isaacscript-common` directory. (It assumes that you have `isaacscript-common` linked to a forked development repository.)",
          "type": "boolean"
        },
        "modsDirectory": {
          "description": "The \"mods\" directory that lives next to the \"isaac-ng.exe\" program.",
          "type": "string"
        },
        "saveSlot": {
          "description": "The save slot that you test your mod on.",
          "type": "number"
        }
      },
      "type": "object"
    }
  }
}