Pack

A pack is a collection of games (For example : Jackbox Party Pack 9)

id < /th >  < td > packs/pack.json < /td >  < /tr >  < tr >  < th>schema http://json-schema.org/draft-07/schema#

Properties

Name Type
id String
resource_location Object
name String
description String
launchers_id Object (of type LaunchersId)
executables Object (of type Executables)
loader Object (of type Loader)
configuration Object (of type Pack Configuration)
patchs Array [PackPatch]
games Array [Game]
icon String
background String

id

Description The unique identifier for a pack
Type String
Required Yes
Examples
  • jpp2
  • resource_location

    Description Override the game path for this pack
    Type Object
    Required No

    Properties

    Name Type
    windows String
    mac String
    linux String

    resource_location.windows

    Type String
    Required No

    resource_location.mac

    Type String
    Required No

    resource_location.linux

    Type String
    Required No

    name

    Description The name of the pack
    Type String
    Required Yes
    Examples
  • The Jackbox Party Pack 2
  • description

    Description The description of the pack
    Type String
    Required Yes
    Examples
  • The sequel to the party game phenomenon The Jackbox Party Pack
  • launchers_id

    Defined in launchersId.html

    $id packs/launchersId.json
    Title LaunchersId
    Type Object (of type LaunchersId)
    Required No

    Properties

    Name Type
    steam String
    epic String

    executables

    Defined in executables.html

    $id packs/executables.json
    Title Executables
    Description The executable files for the game
    Type Object (of type Executables)
    Required No

    Properties

    Name Type
    windows String
    mac String
    linux String

    loader

    Defined in loader.html

    $id packs/loader.json
    Title Loader
    Description The default loader for this pack
    Type Object (of type Loader)
    Required No

    Properties

    Name Type
    path String
    version String

    configuration

    Defined in packConfiguration.html

    $id packs/packConfiguration.json
    Title Pack Configuration
    Description Configuration for a pack. It changed the behavior of the pack for this pack
    Type Object (of type Pack Configuration)
    Required No

    Properties

    Name Type
    version_origin String
    version_file String
    version_property String

    patchs

    Defined in packPatch.html

    Type Array [PackPatch]
    Required Yes

    games

    Defined in game.html

    Type Array [Game]
    Required Yes

    icon

    Type String
    Required Yes

    background

    Type String
    Required Yes

    Schema

    {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "$id": "packs/pack.json",
        "title": "Pack",
        "description": "A pack is a collection of games (For example : Jackbox Party Pack 9)",
        "type": "object",
        "properties": {
            "id": {
                "examples": [
                    "jpp2"
                ],
                "description": "The unique identifier for a pack",
                "type": "string"
            },
            "resource_location": {
                "type": "object",
                "description": "Override the game path for this pack",
                "properties": {
                    "windows": {
                        "type": "string"
                    },
                    "mac": {
                        "type": "string"
                    },
                    "linux": {
                        "type": "string"
                    }
                }
            },
            "name": {
                "examples": [
                    "The Jackbox Party Pack 2"
                ],
                "description": "The name of the pack",
                "type": "string"
            },
            "description": {
                "examples": [
                    "The sequel to the party game phenomenon The Jackbox Party Pack"
                ],
                "description": "The description of the pack",
                "type": "string"
            },
            "launchers_id": {
                "$ref": "launchersId.json"
            },
            "executables": {
                "$ref": "executables.json"
            },
            "loader": {
                "type": "object",
                "$ref": "loader.json",
                "description": "The default loader for this pack"
            },
            "configuration": {
                "$ref": "packConfiguration.json"
            },
            "patchs": {
                "type": "array",
                "items": {
                    "$ref": "packPatch.json",
                    "type": "object"
                }
            },
            "games": {
                "type": "array",
                "items": {
                    "$ref": "game.json",
                    "type": "object"
                }
            },
            "icon": {
                "type": "string"
            },
            "background": {
                "type": "string"
            }
        },
        "required": [
            "id",
            "name",
            "description",
            "patchs",
            "games",
            "icon",
            "background"
        ]
    }