Getting Started
Kaiju Multiplayer Engine, abbreviated as KMPE throughout this documentation, can be purchased from the Unity Asset Store. As an Extension Asset of the Standard Unity Asset Store EULA License, one license is required per user.
Currently, KMPE requires Unity 6.3 LTS or Unity 6.4 Supported. We aim to support the latest LTS and if any exist, supported Unity releases beyond the latest LTS version. As Steam only supports Windows, Mac, and Linux, KMPE only works on these platforms. While KMPE won't function on other platforms, it has been designed to not throw errors on these platforms, meaning you can safely keep KMPE in your project for cross-platform games.
Before downloading KMPE, it is recommended you install Git as many integrations need Git for an easy installation. If you choose not to install Git, you can still use KMPE but will need to manually install tools such as Steamworks.NET. Additionally, if you choose to manually install any packages, you may need to further manually add preprocessor directives for said packages. For this reason, it is highly recommended you install packages with Git. For more, see the Unity documentation on Git packages.
From the asset store page, click "Open in Unity". If already in Unity, open the package manager window by going to Window > Package Management > Package Manager from the top menu, click on My Assets, and search for Kaiju Multiplayer Engine. Click the Import button. If the Import button does not appear, first click the Download button and once finished you can import KMPE.
If Steamworks.NET, the core dependency of KMPE, is already installed, you are ready to move on to the next steps! Otherwise, the setup wizard will open to guide you through the rest of the setup.
Setup Wizard
The setup wizard will allow you to easily install dependencies and networking library integrations. At a minimum, Steamworks.NET must be installed, and it is recommended to install either Multiplayer Play Mode or ParrelSync to simulate local multiplayer.
Additionally, you can click to install your choice of networking library.
You can open the wizard at any time by going to Windows > Kaiju Solutions > Multiplayer Engine > Wizard or Tools > Kaiju Solutions > Multiplayer Engine > Windows > Wizard from the top menu.
Dependencies and Integrations
You can manage dependencies and integrations outside of the setup wizard by going to Tools > Kaiju Solutions > Multiplayer Engine > Dependencies and Tools > Kaiju Solutions > Multiplayer Engine > Integrations from the top menu.
Preprocessor Directives
KMPE uses conditional compilation to enable and disable functionality based on what dependencies and integrations are installed. Below are the preprocessor directives which KMPE uses which can be set by going to Edit > Project Settings from the top menu, selecting Player, and scrolling down to Scripting Define Symbols:
DISABLE_KAIJU_VOICE- Set this flag to disable KMPE's voice chat system. Set this if you are using a third-party system to handle your voice chat.DISABLE_KAIJU_STATS- Set this flag to disable KMPE's achievements, stats, and leaderboards system. Set this if you are using a third-party system to handle Steam achievements, stats, and leaderboards.DISABLE_KAIJU_OVERLAY- Set this flag to disable KMPE's Steam overlay system. Set this if you are using a third-party system to handle the Steam overlay.DISABLE_KAIJU_DEV- Set this flag to disable KMPE's developer UI.DISABLE_KAIJU_SYNC- Set this flag to disable KMPE's synchronization features.
Below are additional compilation flags. These are automatically added when a given package is detected as being installed, with the only exception being if certain integrations are manually installed, in which case you may need to add them as a preprocessor directive.
KAIJU_STEAMWORKS_NET- For when Steamworks.NET is installed.KAIJU_MULTIPLAYER_PLAY_MODE- For when Multiplayer Play Mode is installed.KAIJU_PARREL_SYNC- For when ParrelSync is installed.KAIJU_NETCODE_FOR_GAMEOBJECTS- For when Netcode for GameObjects is installed.KAIJU_PURRNET- For when PurrNet is installed.KAIJU_FISHNET- For when FishNet is installed.KAIJU_MULTIPLAYER_ENGINE_VALID- This is defined within scripts when Steamworks.NET is installed and the project is on a desktop platform to enable KMPE functionality. Never manually define this in your preprocessor directives.KAIJU_AUDIO- This is defined within assembly definitions when the Unity Audio Module is installed. Never manually define this in your preprocessor directives.
Next Steps
While not required, you will likely want to install either Multiplayer Play Mode or ParrelSync to simulate local multiplayer. For more on this, see the testing page. See either the setup wizard or dependency management sections for how to install these tools.
To get up and running, simply add the KaijuMultiplayerManager component to the scene. If not already present, this will add the required steam_appid.txt, which is required by Steamworks.NET, to the root of the project, and sync the ID. The KaijuMultiplayerManager is a singleton, meaning only one instance ever exists across all scenes. You can safely add a KaijuMultiplayerManager into all scenes and it will automatically ensure only one exists at runtime. Most KMPE functionality is accessed through the KaijuMultiplayerManager in a static manner.
To create a Steam game, you will need to obtain a Steamworks application ID. To obtain one, you will need to sign into Steamworks and sign up as a developer. While developing, it is common to use the application ID of 480 as a placeholder before obtaining your own. The application ID of 480 is a development ID provided by Steam. While using the application ID of 480, you will appear as playing "Spacewar" on Steam, and certain Steamworks features which require configuration on the Steamworks backend will not function. However, the application ID of 480 is fully capable of testing the core matchmaking and networking features provided with KMPE.
Next, learn how to create and find matches, how to implement networking between players including what frameworks are supported, and how to get player information.