mods-schema.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "DREDGE mods list schema",
    "type": "object",
    "additionalProperties": false,
    "required": [
        "mods"
    ],
    "properties": {
        "$schema": {
            "type": "string"
        },
        "mods": {
            "type": "array",
            "items": {
                "additionalProperties": false,
                "required": [
                    "name",
                    "mod_guid",
                    "repo",
		    "download"
                ],
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "Human-readable title for your mod."
                    },
                    "mod_guid": {
                        "type": "string",
                        "description": "Unique ID for your mod. Recommended to take the form yourname.modname - ex, 'xen-42.cosmichorrorfishingbuddies'."
                    },
                    "repo": {
                        "type": "string",
                        "description": "URL for the GitHub repo of this mod, but only the username and repo name - ex, 'xen-42/cosmic-horror-fishing-buddies"
                    },
                    "download": {
                        "type": "string",
                        "description": "The name of the asset to be downloaded from the release - ex, 'CosmicHorrorFishingBuddies.zip'."
                    },
                    "author": {
                        "type": "string",
                        "description": "The name of the author of the mod. Leave this blank to use your GitHub account name / organization name."
                    },
                    "description": {
                        "type": "string",
                        "description": "The description of the mod. Leave this blank to use the About line from the GitHub repo."
                    },
                    "downloads_offset": {
                        "type": "number",
                        "description": "The amount to add to the download count."
                    },
                    "readme_path": {
                        "type": "string",
                        "description": "Path to the readme file for this mod in the default branch."
                    }
                }
            }
        }
    }
}