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.

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.

Installation Instructions

GS2 SDK for Unity Installer Version 2022.3.1

Start the Unity Editor and import the .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.

UIKit

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.

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.

Installation Instructions

The latest SDK can be obtained from GitHub Tags

https://github.com/gs2io/gs2-sdk-for-ue5/tags

Various programming languages

https://github.com/gs2io/gs2-php-sdk

Install from Composer

gs2-php-sdk

composer require gs2/gs2-php-sdk

https://github.com/gs2io/gs2-golang-sdk

Install from Go mod

go install github.com/gs2io/gs2-golang-sdk@latest

https://github.com/gs2io/gs2-python-sdk

Install from PyPI

gs2

pip install gs2

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-php-cdk

Install from Composer

gs2-php-cdk

composer require gs2/gs2-php-cdk

https://github.com/gs2io/gs2-golang-cdk

Install from Go mod

go install github.com/gs2io/gs2-golang-cdk@latest

https://github.com/gs2io/gs2-python-cdk

Install from PyPI

gs2-cdk

pip install gs2-cdk

Have you finished installing the SDK?

Next, let’s try the tutorial to see GS2 in action.


Tutorial

Let’s implement creating an account and logging in with Game Server Services.

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