Tutorial
Let’s implement creating an account and logging in with Game Server Services.
Start using GS2
How to start using Game Server Services.
SDK
Game Engine
Game Server Services provides SDKs for all major game engines. The SDK for game engines is provided in a higher level API format than the regular SDK, with a focus on use from within the game.
GS2 SDK for Unity
This SDK is distributed under the Apache License 2.0.
You must clearly indicate somewhere in your program that you are using libraries provided under the Apache License 2.0.
This SDK includes LitJson (Gs2/Plugin/LitJSON.dll), which is in the public domain.
This dll is used for operations that are fundamental to the operation of the GS2 SDK and cannot be removed.
This SDK includes websocket-sharp(Gs2/Plugin/websocket-sharp.dll) which is licensed under the MIT License.
The license that should be noted is as follows
https://raw.githubusercontent.com/sta/websocket-sharp/master/LICENSE.txt
This dll is used for operations that are fundamental to the operation of the GS2 SDK, so it cannot be removed.
This SDK includes protobuf (Gs2/Plugin/Google.Protobuf.dll) which is licensed under BSD.
The license that should be noted is as follows
https://github.com/protocolbuffers/protobuf/blob/master/LICENSE
This dll can be removed if you are not using GS2-Realtime.
GS2 SDK for Unity Installation Instructions
GS2 SDK for Unity Installer Version 2024.4.1
Download the installer in UnityPackege format from the link above.
Start the Unity Editor and import the gs2-unity-installer_2024.4.1.unitypackage file from the Import Package menu.
Then select “Window > Game Server Services > SDK Installer” from the Unity Editor menu and follow the instructions in the wizard.
If the installation does not work properly after installation is complete, try restarting the Unity Editor once.
Details of the SDK setup procedure
GS2 UIKit for Unity
GS2 UIKit for Unity is designed to allow implementation of GS2 functionality using the Unity Editor interface without writing code.
After installing the SDK installer, select “Window > Game Server Services > UIKit for Unity Installer” from the Unity Editor menu and follow the wizard instructions. If the installation does not work properly after the installation is complete, try restarting the Unity Editor once.
For a tutorial on UIKit, see here.
GS2 SDK for Unreal Engine 5
The SDK itself is licensed under the Apache License 2.0.
You need to specify that you are using the library provided under the Apache License 2.0 somewhere in your program.
GS2 SDK for UE5 Installation Instructions
The latest SDK can be obtained from GitHub.
https://github.com/gs2io/gs2-sdk-for-ue5/
Install as a project plugin
Download the source code from GitHub and place it in the following folder in your Unreal Engine project
(Unreal Engine Project)/Plugins/Gs2Plugin
If the Plugins folder does not exist, create it.
Run uproject in UnrealEditor, activate the GS2 plugin, and restart UnrealEditor.
Detailed SDK Setup Instructions
Install as an engine plugin
You can get the Unreal Engine source code from Github or Perforce and install it as an engine plugin in the environment where you are building the Engine.
Place the downloaded source code in the following folder in the Unreal Engine source code.
(Unreal Engine source code)/Engine/Plugins/Gs2Plugin
Run uproject in UnrealEditor, activate the GS2 plugin, and restart UnrealEditor.
Various programming languages
You can use GS2 with various programming languages, including Go, PHP, Java, C#, TypeScript, and Python. You can download the source code from GitHub or obtain it through the respective package managers.
https://github.com/gs2io/gs2-golang-sdk
Install from Go mod
go install github.com/gs2io/gs2-golang-sdk@latest
CDK
CDK stands for Cloud Development Kit, a development kit that enables GS2 orchestration in code.
To explain the functionality more concretely, you can write code to instantiate an object corresponding to a GS2 resource in the CDK and call the Dump API to generate a GS2 Deploy template. GS2-Deploy templates can be written in YAML format, but because YAML files are not program code, they cannot import external files or execute loops, and to optimize the workflow it was necessary to write code to generate templates. CDK is a solution to streamline such a workflow, allowing you to parse master data Excel files and generate GS2-Deploy templates while defining event durations in a loop within the tool using CDK.
https://github.com/gs2io/gs2-golang-cdk
Install from Go mod
go install github.com/gs2io/gs2-golang-cdk@latest
Have you finished installing the SDK?
Next, let’s try the tutorial to see GS2 in action.
GS2 UIKit for Unity Tutorial
How to use GS2 UIKit for Unity.
GS2-SDK for UE5 Blueprint Tutorial
implement GS2-SDK for UE5 Blueprint to create an account and login