schema/gameDetection.json at master · LavishSoftware/schema · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://www.lavishsoft.com/schema/gameDetection.json",
    "description": "An Inner Space Game Detections file, used to detect games for Inner Space",
    "type": "object",
    "definitions": {
        "game": {
            "type": "object",
            "title": "An Inner Space Game Detection",
            "description": "A list of game executables and ways of detecting and launching them, and any special options required for this game",
            "properties": {
                "name": {
                    "type": "string"
                },
                "executables": {
                    "type": "object",
                    "description": "A list of executables for this game, and whether to detect as client, launcher, or disable (do not detect this game based on that executable)",
                    "additionalProperties": {
                        "enum": [
                            "launcher",
                            "client",
                            "disable"
                        ]
                    }
                },
                "paths": {
                    "type": "array",
                    "description": "A list of path detections for this game",
                    "items": {
                        "type": "object",
                        "properties": {
                            "detectionType": {
                                "description": "Method of game detection",
                                "enum": [
                                    "file",
                                    "uninstallKey",
                                    "registryKey",
                                    "appPathKey"
                                ]
                            },
                            "pathOffset": {
                                "description": "If the detected path does not point directly to the game folder, this relative path offset (such as x64 or ..) will be added",
                                "type": "string",
                                "examples": [
                                    "x64",
                                    "..",
                                    "_retail_"
                                ]
                            }
                        },
                        "required": [
                            "detectionType"
                        ],
                        "oneOf": [
                            {
                                "properties": {
                                    "detectionType": {
                                        "const": "file"
                                    },
                                    "filename": {
                                        "description": "Filename to search for. If this file exists in the specified location, the game is detected there",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "filename"
                                ]
                            },
                            {
                                "properties": {
                                    "detectionType": {
                                        "const": "uninstallKey"
                                    },
                                    "id": {
                                        "description": "Uninstall ID to search for. If the Uninstall key exists, the game is detected in the specified location",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "id"
                                ]
                            },
                            {
                                "properties": {
                                    "detectionType": {
                                        "const": "registryKey"
                                    },
                                    "key": {
                                        "enum": [
                                            "HKLM",
                                            "HKCU"
                                        ]
                                    },
                                    "subkey": {
                                        "type": "string"
                                    },
                                    "value": {
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "key",
                                    "subkey",
                                    "value"
                                ]
                            },
                            {
                                "properties": {
                                    "detectionType": {
                                        "const": "appPathKey"
                                    },
                                    "filename": {
                                        "type": "string",
                                        "description": "App Paths filename to search for. If the App Paths filename exists, the game is detected in the specified location"
                                    }
                                },
                                "required": [
                                    "filename"
                                ]
                            }
                        ]
                    }
                },
                "profiles": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "name": {
                                "type": "string",
                                "description": "Name for the Game Profile"
                            },
                            "executable": {
                                "type": "string",
                                "description": "Main executable filename",
                                "examples": [
                                    "steam.exe",
                                    "launcher.exe",
                                    "wow.exe"
                                ]
                            },
                            "parameters": {
                                "type": "string",
                                "description": "Main executable parameters (Any parameters to be passed to the executable)",
                                "examples": [
                                    "patchme"
                                ]
                            },
                            "pathOffset": {
                                "description": "If the detected path does not point directly to the game folder for this Game Profile, this relative path offset (such as x64 or ..) will be added",
                                "type": "string",
                                "examples": [
                                    "x64",
                                    "..",
                                    "_retail_"
                                ]
                            },
                            "killBeforeLaunch": {
                                "type": "string",
                                "description": "An executable filename to terminate before launching this Game Profile. This is particularly useful for game launchers that can only have a single instance running at a time.",
                                "examples": [
                                    "launcher.exe",
                                    "battle.net.exe"
                                ]
                            }
                        },
                        "required": [
                            "name",
                            "executable"
                        ]
                    }
                },
                "settings": {
                    "type": "object",
                    "description": "Inner Space Game Settings to be applied to the Inner Space Game",
                    "properties": {
                        "Lock Foreground": {
                            "type": "integer",
                            "enum": [
                                0,
                                1
                            ],
                            "description": "Set to 1 if the game should always believe and act as though it is the foreground window"
                        }
                    }
                }
            },
            "required": [
                "name"
            ]
        }
    },
    "properties": {
        "games": {
            "type": "array",
            "description": "A list of games that can be detected",
            "items": {
                "$ref": "#/definitions/game"
            }
        }
    },
    "required": [
        "games"
    ]
}