Skip to main content

Game EMH Object

idinteger<int32>

Unique game id.

Example: 2
statusStatus Enum (integer)
Enum ValueDescription
NOT_ACCEPTED (0)Not Accepted
ACCEPTED (1)Accepted
DELETED (3)Deleted

Possible values: [0, 1, 3]

community_optionsGame Community Option Enum (integer)

Community features enabled for this game. Add the options you want together, to enable multiple features (see BITWISE fields)

Enum ValueDescription
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]

Example: 0
curation_optionCuration Enum (integer)

Curation option enabled by this game to approve mods.

Enum ValueDescription
DISABLED (0)Disabled
MARKETPLACE_QUEUE (1)Marketplace queue
LIVE_REQUIRES_APPROVAL (2)Live requires approval

Possible values: [0, 1, 2]

Example: 0
ugc_namestring

Word used to describe user-generated content (mods, items, addons etc).

Example: mods
namestring

Name of the game.

Example: Rogue Knight
name_idstring

Path for the game on mod.io. For example: https://mod.io/g/__rogue-knight__

Example: rogue-knight
instructionsstring

A guide about creating and uploading mods for this game to mod.io (applicable if submission_option = 0).

Example: 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).

  • Array [
  • namestring

    Name of the tag group.

    Example: Theme
    name_localizedstring
    typestring

    Can multiple tags be selected via 'checkboxes' or should only a single tag be selected via a 'dropdown'.

    Example: checkboxes
    tagsstring[]

    Array of tags in this group.

    tags_localized object

    List of tag names and the localized variant of the tag.

    property name*string
    tag_count_map object

    List of tag names and the count of mods with these tags.

    property name*integer<int32>
    hiddenboolean

    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.

    Example: false
    lockedboolean

    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).

    Example: false
  • ]
  • dependency_optionDependency Enum (integer)

    Dependency option for this game's mods.

    Enum ValueDescription
    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]

    Example: 0
    maturity_optionsGame Maturity Enum (integer)

    Mature content setup for this game.

    Enum ValueDescription
    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_optionSubmission Options Enum (integer)

    Submission process modders must follow.

    Enum ValueDescription
    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]

    Example: 0
    theme object

    Contains theme variables.

    primarystring

    The primary hex color code.

    Example: #44bfd5
    darkstring

    The dark hex color code.

    Example: #2c2c3f
    lightstring

    The light hex color code.

    Example: #ffffff
    successstring

    The success hex color code.

    Example: #68D391
    warningstring

    The warning hex color code.

    Example: #d6af2e
    dangerstring

    The danger hex color code.

    Example: #ff000e
    platforms object[]

    Platforms that are supported by this title.

  • Array [
  • platformPlatform String Enum (string)

    A target platform.

    Enum ValueDescription
    ALLAll Platforms
    WINDOWSWindows
    MACMac
    LINUXLinux
    ANDROIDAndroid
    IOSIphone IOS
    XBOXONEXbox One
    XBOXSERIESXXbox Series X
    PLAYSTATION4Playstation 4
    PLAYSTATION5Playstation 5
    SWITCHSwitch
    OCULUSOculus
    SOURCESource

    Possible values: [ALL, WINDOWS, MAC, LINUX, ANDROID, IOS, XBOXONE, XBOXSERIESX, PLAYSTATION4, PLAYSTATION5, SWITCH, OCULUS, SOURCE]

    Example: PLAYSTATION5
    labelstring

    A presentable label of the platform.

    Example: PlayStation 5
    moderatedboolean

    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.

    Example: true
    lockedboolean

    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.

    Example: true
  • ]
  • Game EMH Object
    {
    "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
    }
    ]
    }