Skip to main content

Engines

A Blazium game uses the engine module. A game on Godot, Unity, or Unreal uses the binding for that engine. All three cover init, callbacks, the logged-on user, lobbies, a Steam ticket, and a bug report.

macOS has no player build of the native library. Windows uses blazium_api64.dll. Linux uses libblazium_api.so.

Godot​

Copy addons/blazium_games into the project, enable the plugin, and set the project setting blazium/game/game_uid to the project id. The addon signs in, then uses that session for the lobby and for peer connections. Sign-in and lobbies are described in Multiplayer.

The addon is blazium-games/games_plugin.

Unity​

The package name is com.blazium.games. Install a release tarball with Package Manager (Add package from tarball), or copy the package into the project as Packages/com.blazium.games. Package Manager can import the Client and Dedicated server samples.

Put blazium_api64.dll or libblazium_api.so in Assets/Plugins/x86_64. Put game.blaze beside the built player. Add a BlaziumTick component to one object. It calls RunCallbacks from Update. Do not also call RunCallbacks every frame.

Do not call BlaziumApi.Init and BlaziumGameServer.Init in the same process.

The package is blazium-games/games_unity.

Unreal​

Copy the BlaziumGames folder from a release zip to Plugins/BlaziumGames and enable Blazium Games. Windows (Win64) and Linux are the supported targets.

Put blazium_api64.dll or libblazium_api.so and game.blaze beside the game executable. UBlaziumSubsystem calls RunCallbacks while a session is open. Do not also call it every frame. Blueprint nodes are in the Blazium category.

Do not call client init and dedicated-server init in the same process.

The plugin is blazium-games/games_unreal.

game.blaze​

UTF-8 JSON beside the player executable. Unity and Unreal do not write this file.

{
  "game_uid": "550e8400-e29b-41d4-a716-446655440000"
}

game_uid is the project id on blazium.games. No other keys are allowed.

The native library talks to the Blazium launcher on the player's machine. The Unity package and the Unreal plugin do not call api.blazium.online. Lobby, ICE, Steam ticket, and bug report calls return JSON. File a bug with the in-game reporter.

Godot, Unity, and Unreal also share ownership, achievement unlocks, stat writes, funnel events, Progress() to read unlocks and stat values, SetPresence when the client may write presence, and the patch-note pull described in Deploy builds.