Skip to content

Consoles

Building

Precompiled binaries are not distributed for consoles and will require the plugin built for each platform.

Each console Logic Driver needs to run on requires the correct platform added to SMSystem.uplugin. For each module of type Runtime add the console's platform key to the PlatformAllowList.

      "Name": "SMSystem",
      "Type": "Runtime",
      "LoadingPhase": "PreDefault",
      "PlatformAllowList": [
        "Win64",
        "Mac",
        "Linux",
        "Android",
        "IOS",
        "TVOS",
        "[YOUR_CONSOLE_PLATFORM]"
      ]

[YOUR_CONSOLE_PLATFORM] should be changed to the console you are adding. For example, PlayStation 4 is added as PS4, PlayStation 5 is PS5, Nintendo Switch is Switch, and Xbox One may be XboxOne or XboxOneGDK.

Console SDK Version

These keys may change based on the console SDK version. To get the correct key to use, consult your console SDK documentation.

The known keys used to be included with the plugin in Unreal Engine 4, but in Unreal Engine 5 the keys are no longer in the public branches of the engine. The engine will throw warnings if an unrecognized key is included in a plugin.

Support

The plugin is not compiled or tested against any console SDKs locally, but there are multiple games that have been released or are in development for consoles. The runtime modules are designed to be cross-platform and tested consistently on Windows, MacOS, and Linux. If support is required on consoles, then the Pro version of the plugin, along with the correct licensing and support agreement, may be required.