flatpaker.schema.json

{
    "$defs": {
        "AppData": {
            "description": "The appdata section of the build toml description.",
            "properties": {
                "summary": {
                    "description": "A short description of the game",
                    "title": "Application summary",
                    "type": "string"
                },
                "description": {
                    "description": "A longer description of the game.",
                    "title": "Application description",
                    "type": "string"
                },
                "content_rating": {
                    "additionalProperties": {
                        "enum": [
                            "none",
                            "mild",
                            "moderate",
                            "intense"
                        ],
                        "type": "string"
                    },
                    "description": "Content information for the current game.",
                    "propertyNames": {
                        "enum": [
                            "drugs-alcohol",
                            "drugs-narcotics",
                            "drugs-tobacco",
                            "language-descrimination",
                            "language-humor",
                            "language-profanity",
                            "money-gambling",
                            "money-purchasing",
                            "sex-nudity",
                            "sex-themes",
                            "social-audio",
                            "social-chat",
                            "social-contacts",
                            "social-info",
                            "social-location",
                            "violence-bloodshed",
                            "violence-cartoon",
                            "violence-fantasy",
                            "violence-realistic",
                            "violence-sexual"
                        ]
                    },
                    "title": "OARS Content Rating Information",
                    "type": "object"
                },
                "releases": {
                    "additionalProperties": {
                        "type": "string"
                    },
                    "description": "Mapping of releases in the form `\"YYYY-MM-DD\" = \"X.Y.Z\"",
                    "title": "Release information for this game",
                    "type": "object"
                },
                "license": {
                    "default": "LicenseRef-Proprietary",
                    "description": "A valid SPDX license Expression for this game",
                    "title": "SPDX License Expression",
                    "type": "string"
                }
            },
            "required": [
                "summary",
                "description"
            ],
            "title": "Application Metadata",
            "type": "object"
        },
        "Archive": {
            "description": "An archive entry in the sources section of the build toml description.",
            "properties": {
                "path": {
                    "description": "A local path to the sources. Must be relative to this file, or absolute.",
                    "format": "path",
                    "title": "Path to source",
                    "type": "string"
                },
                "sha256": {
                    "anyOf": [
                        {
                            "maxLength": 64,
                            "minLength": 64,
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "Hexedecimal representatio of the SHA256 of this file.",
                    "title": "SHA256 Hash"
                },
                "commands": {
                    "description": "Shell commands are run immediately after copying this source to the build directory",
                    "items": {
                        "type": "string"
                    },
                    "title": "Extra shell commands",
                    "type": "array"
                },
                "strip_components": {
                    "default": 1,
                    "description": "number of path elements to strip from patches. Passed to `patch -p N`",
                    "title": "Patch strip argument",
                    "type": "integer"
                }
            },
            "required": [
                "path"
            ],
            "title": "An archive source",
            "type": "object"
        },
        "Common": {
            "description": "The common section of the build toml description.",
            "properties": {
                "reverse_url": {
                    "description": "A reverse root URL for the game. The Game name will be automatically appended from the name field. This cannot be changed.",
                    "example": "com.github.user",
                    "title": "Reverse URL",
                    "type": "string"
                },
                "name": {
                    "description": "The proper name with punctionation and spaces for this game",
                    "example": "Soldier's Quest",
                    "title": "Proper Name",
                    "type": "string"
                },
                "engine": {
                    "description": "Which engine (and runtime) this game uses",
                    "enum": [
                        "renpy8",
                        "renpy7",
                        "renpy7-py3",
                        "rpgmaker"
                    ],
                    "title": "Engine name",
                    "type": "string"
                },
                "categories": {
                    "description": "Valid categories for the game's .destkop file. 'Game' is added automatically",
                    "items": {
                        "enum": [
                            "ActionGame",
                            "Adult",
                            "AdventureGame",
                            "Amusement",
                            "ArcadeGame",
                            "BlocksGame",
                            "BoardGame",
                            "CardGame",
                            "Emulator",
                            "KidsGame",
                            "LogicGame",
                            "RolePlaying",
                            "Shooter",
                            "Simulation",
                            "SportsGame",
                            "StrategyGame"
                        ],
                        "type": "string"
                    },
                    "title": "Freedesktop Application Categories",
                    "type": "array"
                }
            },
            "required": [
                "reverse_url",
                "name",
                "engine"
            ],
            "title": "common",
            "type": "object"
        },
        "File": {
            "description": "A file entry in the sources section of the build toml description.",
            "properties": {
                "path": {
                    "description": "A local path to the sources. Must be relative to this file, or absolute.",
                    "format": "path",
                    "title": "Path to source",
                    "type": "string"
                },
                "sha256": {
                    "anyOf": [
                        {
                            "maxLength": 64,
                            "minLength": 64,
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "Hexedecimal representatio of the SHA256 of this file.",
                    "title": "SHA256 Hash"
                },
                "dest": {
                    "default": "game",
                    "description": "Relative path to install this file to.",
                    "title": "Installation location",
                    "type": "string"
                },
                "commands": {
                    "description": "Shell commands are run immediately after copying this source to the build directory",
                    "items": {
                        "type": "string"
                    },
                    "title": "Extra shell commands",
                    "type": "array"
                }
            },
            "required": [
                "path"
            ],
            "title": "A single file type source",
            "type": "object"
        },
        "Patch": {
            "description": "A patch entry in the sources section of the build toml description.",
            "properties": {
                "path": {
                    "description": "A local path to the sources. Must be relative to this file, or absolute.",
                    "format": "path",
                    "title": "Path to source",
                    "type": "string"
                },
                "sha256": {
                    "anyOf": [
                        {
                            "maxLength": 64,
                            "minLength": 64,
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "Hexedecimal representatio of the SHA256 of this file.",
                    "title": "SHA256 Hash"
                },
                "strip_components": {
                    "default": 1,
                    "description": "number of path elements to strip from patches. Passed to `patch -p N`",
                    "title": "Patch strip argument",
                    "type": "integer"
                }
            },
            "required": [
                "path"
            ],
            "title": "A patch source",
            "type": "object"
        },
        "Quirks": {
            "description": "Quirks of this build that have built-in wokarounds.\n\nThere are a number of common issues, particularly in Ren'Py games that\nflatpaker provides build steps to deal with.",
            "properties": {
                "force_window_gui_icon": {
                    "default": false,
                    "description": "Normally icons from a .exe or .icns if they are avilable, however, some games do not customize these icon sources but do provide a customized incon in the img directory. Setting this to true forces the use of that icon.",
                    "title": "Force use of img/windows_gui/icon.png",
                    "type": "boolean"
                },
                "x_configure_prologue": {
                    "anyOf": [
                        {
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "deprecated": true,
                    "description": "Extra shell commands to run after unpacking sources. This has been replaced with the `commands` field in sources",
                    "title": "Commands to run after unpacking all sources"
                },
                "x_renpy_archived_window_gui_icon": {
                    "anyOf": [
                        {
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "deprecated": true,
                    "description": "Extract an icon from an .rpa icon. This is deprecated, and is now an alias for force_window_gui_icon",
                    "title": "Extract the icon from an RPA archive."
                }
            },
            "title": "Quirks of this game to work around",
            "type": "object"
        },
        "Sources": {
            "description": "The sources section of the build toml description.",
            "properties": {
                "archives": {
                    "description": "Archive type sources, such as .7z, .zip, .tar.gz, etc.",
                    "items": {
                        "$ref": "#/$defs/Archive"
                    },
                    "title": "Archive Sources",
                    "type": "array"
                },
                "patches": {
                    "description": "Patches to be applied after all archives are unpacked",
                    "items": {
                        "$ref": "#/$defs/Patch"
                    },
                    "title": "Patch sources",
                    "type": "array"
                },
                "files": {
                    "description": "extra files to add the build directory",
                    "items": {
                        "$ref": "#/$defs/File"
                    },
                    "title": "source file",
                    "type": "array"
                }
            },
            "required": [
                "archives"
            ],
            "title": "The sources for this build",
            "type": "object"
        }
    },
    "$id": "https://github.com/dcbaker/flatpaker/flatpaker.schema.json",
    "description": "A flatpaker build description for a Ren'Py or RPGMaker MV or MZ game",
    "properties": {
        "common": {
            "$ref": "#/$defs/Common"
        },
        "appdata": {
            "$ref": "#/$defs/AppData"
        },
        "quirks": {
            "$ref": "#/$defs/Quirks"
        },
        "sources": {
            "$ref": "#/$defs/Sources"
        }
    },
    "required": [
        "common",
        "appdata",
        "sources"
    ],
    "title": "flatpaker",
    "type": "object"
}