Game EMH Object
Unique game id.
2
Enum Value | Description |
---|---|
NOT_ACCEPTED (0) | Not Accepted |
ACCEPTED (1) | Accepted |
DELETED (3) | Deleted |
Possible values: [0
, 1
, 3
]
Community features enabled for this game. Add the options you want together, to enable multiple features (see BITWISE fields)
Enum Value | Description |
---|---|
DISABLED (0) | None |
ALLOW_MOD_COMMENTS (1) | Allow comments on mods |
GUIDES (2) | Allow guides |
PIN_HOMEPAGE (4) | Pin on homepage |
SHOW_ON_HOMEPAGE (8) | Show on homepage |
SHOW_MORE_ON_HOMEPAGE (16) | Show more on homepage |
CAN_CHANGE_STATUS (32) | Allow change status |
ALLOW_PREVIEWS (64) | Enable Previews (Game must be hidden) |
ALLOW_PREVIEW_URL (128) | Allow preview share-URL (Previews must be enabled) |
ALLOW_NEGATIVE_RATINGS (256) | Allow negative ratings |
ALLOW_MODS_TO_BE_EDITED_VIA_WEB (512) | Allow mods to be edited via web |
ALLOW_DEPENDENCY (1024) | Allow mod dependencies |
ALLOW_GUIDE_COMMENTS (2048) | Allow comments on guides |
Possible values: [0
, 1
, 2
, 4
, 8
, 16
, 32
, 64
, 128
, 256
, 512
, 1024
, 2048
]
0
Curation option enabled by this game to approve mods.
Enum Value | Description |
---|---|
DISABLED (0) | Disabled |
MARKETPLACE_QUEUE (1) | Marketplace queue |
LIVE_REQUIRES_APPROVAL (2) | Live requires approval |
Possible values: [0
, 1
, 2
]
0
Word used to describe user-generated content (mods, items, addons etc).
mods
Name of the game.
Rogue Knight
Path for the game on mod.io. For example: https://mod.io/g/__rogue-knight__
rogue-knight
A guide about creating and uploading mods for this game to mod.io (applicable if submission_option = 0).
Instructions on the process to upload mods.
tag_options object[]
Groups of tags configured by the game developer, that mods can select. Hidden tags will only be returned if show_hidden_tags
is set to true
. Group names and tags will be localized into the specified Accept-Language
header value if provided, for a list of supported languages see Localization (Note that if a localized variant of a tag is not available it will default to English).
Name of the tag group.
Theme
Can multiple tags be selected via 'checkboxes' or should only a single tag be selected via a 'dropdown'.
checkboxes
Array of tags in this group.
tags_localized object
List of tag names and the localized variant of the tag.
tag_count_map object
List of tag names and the count of mods with these tags.
Groups of tags flagged as 'hidden' are intended to be used for filtering (eg. game version), but should not be displayed to users. Hidden tags will only be returned if show_hidden_tags
is set to true
.
false
Groups of tags flagged as 'locked' are editable only if the authenticated user is a team member of the parent game. Useful for games to tag special functionality, which users can see and filter on (eg. competition winners).
false
Dependency option for this game's mods.
Enum Value | Description |
---|---|
DISALLOW_DEPENDENCIES (0) | Disallow dependencies |
ALLOW_DEPENDENCIES_OPT_IN (1) | Allow dependencies, mods must opt in |
ALLOW_DEPENDENCIES_OPT_OUT (2) | Allow dependencies, mods must opt out |
ALLOW_DEPENDENCIES (3) | Allow dependencies with no restrictions |
Possible values: [0
, 1
, 2
, 3
]
0
Mature content setup for this game.
Enum Value | Description |
---|---|
MODS_DENY (0) | Don't allow mature content in mods |
MODS_ALLOW (1) | Allow mature content in mods |
ADULTS_ONLY (2) | This game is for mature audiences only |
Possible values: [0
, 1
, 2
]
Submission process modders must follow.
Enum Value | Description |
---|---|
CONTROLLED (0) | Mod uploads must occur via the API using a tool created by the game developers |
ALL (1) | Mod uploads can occur from anywhere, including the website and API |
Possible values: [0
, 1
]
0
theme object
Contains theme variables.
The primary hex color code.
#44bfd5
The dark hex color code.
#2c2c3f
The light hex color code.
#ffffff
The success hex color code.
#68D391
The warning hex color code.
#d6af2e
The danger hex color code.
#ff000e
platforms object[]
Platforms that are supported by this title.
Enum Value | Description |
---|---|
ALL | All Platforms |
WINDOWS | Windows |
MAC | Mac |
LINUX | Linux |
ANDROID | Android |
IOS | Iphone IOS |
XBOXONE | Xbox One |
XBOXSERIESX | Xbox Series X |
PLAYSTATION4 | Playstation 4 |
PLAYSTATION5 | Playstation 5 |
SWITCH | Switch |
OCULUS | Oculus |
SOURCE | Source |
Possible values: [ALL
, WINDOWS
, MAC
, LINUX
, ANDROID
, IOS
, XBOXONE
, XBOXSERIESX
, PLAYSTATION4
, PLAYSTATION5
, SWITCH
, OCULUS
, SOURCE
]
PLAYSTATION5
A presentable label of the platform.
PlayStation 5
Is this platform moderated by game admins? If false, then user submissions for the platform will be available immediately providing the game has mod curation disabled.
true
Are users able to upload files to this platform? By default, users are able to upload to all supported platforms, platforms set to true
may only be used by game admins only.
true
{
"id": 2,
"status": 0,
"community_options": 0,
"curation_option": 0,
"ugc_name": "mods",
"name": "Rogue Knight",
"name_id": "rogue-knight",
"instructions": "Instructions on the process to upload mods.",
"tag_options": [
{
"name": "Theme",
"name_localized": "string",
"type": "checkboxes",
"tags": [
"Horror"
],
"tags_localized": {
"Horror": "Horreur"
},
"tag_count_map": {
"Horror": 52
},
"hidden": false,
"locked": false
}
],
"dependency_option": 0,
"maturity_options": 0,
"submission_option": 0,
"theme": {
"primary": "#44bfd5",
"dark": "#2c2c3f",
"light": "#ffffff",
"success": "#68D391",
"warning": "#d6af2e",
"danger": "#ff000e"
},
"platforms": [
{
"platform": "PLAYSTATION5",
"label": "PlayStation 5",
"moderated": true,
"locked": true
}
]
}