GamePatch

A patch for a game

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

Properties

Name Type
id String
name String
supported_platforms Array
small_description String
description String
version String
authors String
patch_path String
patch_type Object (of type patchType.html)

Example

{
    "id": "splittheroom_fr",
    "name": "[PREVIEW] Split The Room",
    "small_description": "[PREVIEW] Traduction du jeu en Français",
    "description": "Le patch complet arrive bientôt. Vous pouvez toujours télécharger la preview mais gardez à l'esprit que la traduction n'est pas terminée. Avec cette preview, le jeu est traduit en français, mais il peut y avoir des fautes. N'hésitez pas à prévenir MisterShaokahn#0765 si il y a des problèmes de traduction",
    "version": "0.1.1_credits",
    "authors": "MisterShaokahn#0765",
    "patch_path": "patchs/splittheroom_0.1.1.zip",
    "patch_type": {
        "game_text": true,
        "game_assets": false,
        "game_subtitles": false,
        "website": false,
        "audios": false
    }
}

id

Description The unique identifier for a game patch
Type String
Required Yes
Examples
  • splittheroom_fr
  • name

    Description The name of the game patch
    Type String
    Required Yes
    Examples
  • [PREVIEW] Split The Room
  • supported_platforms

    Type Array
    Required No

    small_description

    Description A small description of the game patch
    Type String
    Required Yes
    Examples
  • [PREVIEW] Traduction du jeu en Français
  • description

    Description The description of the game patch
    Type String
    Required Yes
    Examples
  • Le patch complet arrive bientôt. Vous pouvez toujours télécharger la preview mais gardez à l'esprit que la traduction n'est pas terminée. Avec cette preview, le jeu est traduit en français, mais il peut y avoir des fautes. N'hésitez pas à prévenir MisterShaokahn#0765 si il y a des problèmes de traduction
  • version

    Description The version of the game patch
    Type String
    Required Yes
    Examples
  • 0.1.1_credits
  • authors

    Description The authors of the game patch
    Type String
    Required Yes
    Examples
  • MisterShaokahn#0765
  • patch_path

    Description The url to the game patch
    Type String
    Required Yes
    Examples
  • patchs/splittheroom_0.1.1.zip
  • patch_type

    Defined in patchType.html

    $id packs/patchType.json
    Description The type of the game patch
    Type Object (of type patchType.html)
    Required Yes

    Properties

    Name Type
    game_text Boolean
    game_assets Boolean
    game_subtitles Boolean
    website Boolean
    audios Boolean

    Schema

    {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "$id": "packs/gamePatch.json",
        "title": "GamePatch",
        "description": "A patch for a game",
        "type": "object",
        "examples": [
            {
                "id": "splittheroom_fr",
                "name": "[PREVIEW] Split The Room",
                "small_description": "[PREVIEW] Traduction du jeu en Français",
                "description": "Le patch complet arrive bientôt. Vous pouvez toujours télécharger la preview mais gardez à l'esprit que la traduction n'est pas terminée. Avec cette preview, le jeu est traduit en français, mais il peut y avoir des fautes. N'hésitez pas à prévenir MisterShaokahn#0765 si il y a des problèmes de traduction",
                "version": "0.1.1_credits",
                "authors": "MisterShaokahn#0765",
                "patch_path": "patchs/splittheroom_0.1.1.zip",
                "patch_type": {
                    "game_text": true,
                    "game_assets": false,
                    "game_subtitles": false,
                    "website": false,
                    "audios": false
                }
            }
        ],
        "properties": {
            "id": {
                "examples": [
                    "splittheroom_fr"
                ],
                "description": "The unique identifier for a game patch",
                "type": "string"
            },
            "name": {
                "examples": [
                    "[PREVIEW] Split The Room"
                ],
                "description": "The name of the game patch",
                "type": "string"
            },
            "supported_platforms": {
                "type": "array",
                "items": {
                    "type": "string",
                    "examples": [
                        [
                            "windows",
                            "mac",
                            "linux"
                        ]
                    ]
                }
            },
            "small_description": {
                "examples": [
                    "[PREVIEW] Traduction du jeu en Français"
                ],
                "description": "A small description of the game patch",
                "type": "string"
            },
            "description": {
                "examples": [
                    "Le patch complet arrive bientôt. Vous pouvez toujours télécharger la preview mais gardez à l'esprit que la traduction n'est pas terminée. Avec cette preview, le jeu est traduit en français, mais il peut y avoir des fautes. N'hésitez pas à prévenir MisterShaokahn#0765 si il y a des problèmes de traduction"
                ],
                "description": "The description of the game patch",
                "type": "string"
            },
            "version": {
                "examples": [
                    "0.1.1_credits"
                ],
                "description": "The version of the game patch",
                "type": "string"
            },
            "authors": {
                "examples": [
                    "MisterShaokahn#0765"
                ],
                "description": "The authors of the game patch",
                "type": "string"
            },
            "patch_path": {
                "examples": [
                    "patchs/splittheroom_0.1.1.zip"
                ],
                "description": "The url to the game patch",
                "type": "string"
            },
            "patch_type": {
                "$ref": "patchType.json"
            }
        },
        "required": [
            "id",
            "name",
            "small_description",
            "description",
            "version",
            "authors",
            "patch_path",
            "patch_type"
        ]
    }