SDK Unreal Engine Plugin
Version: v0.9 (Beta)
All v1.0 features are complete and ready for integration and use. Customer iteration will determine any final changes before labelling as v1.0.
The current version of
i3D.net ONE Game Hosting SDK code used in this plugin is referenced here.
The plugin provides Unreal Engine game servers with the ability to communicate over TCP with the i3D.net ONE Platform, for easy and efficient scaling of game servers.
- Integration guide - How to integrate the plugin into a game server.
- Plugin package - How to package the plugin.
The i3D.net Game Hosting SDK works on Windows and Linux. If you used the guide and you are having problems with the installation, please file an issue.
- Windows 10 Pro
- Ubuntu 18.04
- Minimum compatible Unreal version: 4.25
- Native SDK libraries require C++ Redistributable 2015 to be installed on Windows. Download the installer and follow its instructions:
- Download the
ONE Game Hosting Pluginfrom the Unreal Marketplace.
- Copy the plugin folder into
C:\Program Files\Epic Games\UE_4.26\Engine\Plugins.
- In Unreal Engine Editor, go to Edit > Plugins menu.
- Select the plugin from step 1 and click Enable.
- Relaunch the Unreal Editor and open your game.
- Click Add New > Blueprint Class and search for class
One Arcus Server.
- Drag in the new
One Arcus Serverinto a persistent level, so that the
One Arcus Serverpersist during the whole game life cycle.
- Follow the next task: How to test below.
There are two ways to test a Game Server that is running an
One Arcus Server:
- The SDK contains a Fake Agent that can connect and simulate a real deployment. Build and run instructions can be found here.
- The Game Server can be uploaded to a live One Development Platform Deployment.
Testing can be performed either in Unreal Engine Editor or on a build running in headless mode.
This is an optional step for developers that need to locally build and package the plugin.
C:\Program Files\Epic Games\UE_4.26\Engine\Build\BatchFilesin the
Build the Arcus plugin:
one-gamehosting-sdk-unrealrepository is cloned in the folder
b. Run the following command to build the sdk plugin: (Where ... is the working directory where you want to copy the plugin.)
RunUAT.bat BuildPlugin -plugin="%USERPROFILE%/source/repos/one-gamehosting-sdk-unreal/4.26/ONEGameHostingPlugin/ONEGameHostingPlugin.uplugin" -package="%USERPROFILE%/.../Plugins/ONEGameHostingPlugin"
c. Copy the
ONEGameHostingPlugininto Unreal Engine plugin directory: C:\Program Files\Epic Games\UE_4.26\Engine\Plugins\One, since it cannot be set directly through their toolchain.
- Follow the Linux Quick Start for instructions on how to build the Unreal Engine locally.
- For the following steps: the
UnrealEngineis cloned in the folder
one-gamehosting-sdk-unrealis cloned in the folder
~/src/one-gamehosting-sdk-unreal. Make sure that the folder is created
Build the Arcus plugin and run the following command:
``` ~/src/UnrealEngine/Engine/Build/BatchFiles/RunUAT.sh BuildPlugin -plugin=../one-gamehosting-sdk-unreal/4.26/ONEGameHostingPlugin/ONEGameHostingPlugin.uplugin -package=../One/ONEGameHostingPlugin -TargetPlatform=Linux ````
Copy the folder
For developers using this plugin
Optional - The target audience is software developers that want to build the plugin locally without using pre-built plugin from the Unreal Engine marketplace.