> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2の利用を開始

Game Server Services の利用を開始する方法について




## SDK

### Game Engine

Game Server Services は 主要なゲームエンジンから利用できるSDKを提供しています。<br>
ゲームエンジン向け SDK では、ゲーム内から利用することにフォーカスして通常の SDK より高レベルなAPI形式で提供しています。


{{% tab header="**Language**:" disabled=true /%}}
{{% tab header="Unity" %}}

#### GS2 SDK for Unity

本 SDK は Apache License 2.0 で提供されています。<br>
プログラムのどこかで Apache License 2.0 で提供されているライブラリを使用していることを明示する必要があります。

本 SDK にはパブリックドメインである LitJson(Gs2/Plugin/LitJSON.dll) が含まれています。<br>
この dll は GS2 SDK の動作の根幹に関わる動作に利用されているため、削除することが出来ません。

本 SDK には MIT License である websocket-sharp(Gs2/Plugin/websocket-sharp.dll) が含まれています。<br>
表示・表記が必要なライセンス条文は以下です。<br>
https://raw.githubusercontent.com/sta/websocket-sharp/master/LICENSE.txt<br>
この dll は GS2 SDK の動作の根幹に関わる動作に利用されているため、削除することが出来ません。<br>

本 SDK には BSD License である protobuf(Gs2/Plugin/Google.Protobuf.dll) が含まれています。<br>
表示・表記が必要なライセンス条文は以下です。<br>
https://github.com/protocolbuffers/protobuf/blob/master/LICENSE<br>
この dll は GS2-Realtime を使用しなければ削除することが出来ます。<br>

#### GS2 SDK for Unity の導入手順

[GS2 SDK for Unity Installer Version 2024.4.1](gs2-unity-installer_2024.4.1.unitypackage)

上記リンクよりUnityPackege形式のインストーラーをダウンロードします。

Unity Editor を起動し、メニューの Import Package から gs2-unity-installer_2024.4.1.unitypackage ファイルをインポートします。

その後、Unity Editor のメニューから 『Window > Game Server Services > SDK Installer』 を選択して、ウィザードの指示に従ってください。

インストール完了後、正しく動作しない場合は一度Unity Editorを再起動してみてください。

[SDKのセットアップ手順の詳細](tutorial/setup_sdk/#gs2-sdk-for-unityのインストール手順)

#### GS2 UIKit for Unity

GS2 UIKit for Unityは、ノーコードで Unity Editor の UI を使用してGS2の機能の実装を可能にすることを目的にしています。

SDK インストーラーを導入後、Unity Editor のメニューから 『ウィンドウ > Game Server Services > UIKit for Unity Installer』 を選択して、ウィザードの指示に従ってください。<br>
インストール完了後、正しく動作しない場合は一度Unity Editorを再起動してみてください。

UIKit のチュートリアルは [こちら](uikit) をご確認ください。

[SDKのセットアップ手順の詳細](tutorial/setup_sdk/#gs2-uikit-for-unityのインストール手順)

{{% /tab %}}
{{% tab header="Unreal Engine 5" %}}

#### GS2 SDK for Unreal Engine 5

本 SDK は Apache License 2.0 で提供されています。<br>
プログラムのどこかで Apache License 2.0 で提供されているライブラリを使用していることを明示する必要があります。

#### GS2 SDK for Unreal Engine 5 の導入手順

最新のSDKは GitHub より取得いただけます。

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

#### プロジェクトプラグインとしてインストール

GitHubからソースコードをダウンロードし、Unreal Engineプロジェクト内の以下のフォルダに配置してください。

(Unreal Engineプロジェクト)/Plugins/Gs2Plugin

Pluginsフォルダが存在しない場合は作成してください。

UnrealEditorでuprojectを起動し、GS2プラグインを有効化後、UnrealEditorを再起動してください。

[SDKのセットアップ手順の詳細](tutorial/setup_sdk/#プロジェクトプラグインとしてインストール)

#### エンジンプラグインとしてインストール

Unreal EngineソースコードをGithubもしくはPerforceから取得し、Engineをビルドしている環境に エンジンプラグインとしてインストールが可能です。

ダウンロードしたGS2プラグインのソースコード一式を、Unreal Engineソースコード内の以下のフォルダに配置してください。

(Unreal Engineソースコード)/Engine/Plugins/Gs2Plugin

UnrealEditorでuprojectを起動し、GS2プラグインを有効化後、UnrealEditorを再起動してください。

[SDKのセットアップ手順の詳細](tutorial/setup_sdk/#エンジンプラグインとしてインストール)

{{% /tab %}}


### 各種プログラミング言語

Go、PHP、Java、C＃、TypeScript、Pythonの各種プログラミング言語でGS2の利用が可能です。<br>
GitHubからソースコードをダウンロードするか、それぞれのパッケージマネージャーを介して取得できます。


{{% tab header="**Language**:" disabled=true /%}}
{{% tab header="Go" %}}

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

#### Go mod による取得

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

{{% /tab %}}
{{% tab header="PHP" %}}

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

#### Composerによる取得

[gs2-php-sdk](https://packagist.org/packages/gs2/gs2-php-sdk)

```shell
composer require gs2/gs2-php-sdk
```
{{% /tab %}}
{{% tab header="Java" %}}

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

#### Mavenによる取得

[gs2-java-sdk](https://central.sonatype.com/artifact/io.gs2/gs2-java-sdk)

{{% /tab %}}
{{% tab header="C#" %}}

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

#### NuGet による取得

[GS2.CSharp.Sdk](https://www.nuget.org/packages/GS2.CSharp.Sdk)
{{% /tab %}}
{{% tab header="Typescript" %}}

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

#### npmによる取得

[gs2](https://www.npmjs.com/package/gs2)

```shell
npm i gs2
```
{{% /tab %}}
{{% tab header="Python" %}}

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

#### PyPIによる取得

[gs2](https://pypi.org/project/gs2/)

```shell
pip install gs2
```
{{% /tab %}}


## CDK

CDK とは Cloud Development Kit の略で、GS2 のオーケストレーションをコードで行えるようにするための開発キットです。

より具体的に機能の内容を説明すると、CDK で GS2 リソースに相当するオブジェクトをインスタンス化するコードを記述し、ダンプAPIを呼び出すことで GS2-Deploy のテンプレートを生成することができます。
GS2-Deploy のテンプレートは YAML 形式で記述できますが、YAML ファイルはプログラムのコードではないため、外部ファイルを取り込んだりループを実行することはできず、ワークフローを最適化するためには、テンプレートを生成するためのコードを記述することが求められました。
CDK はこのようなワークフローを最適化するためのソリューションで、CDKを使用したツール内でマスターデータのExcelファイルをパースしたり、イベントの期間をループで定義しつつ GS2-Deploy のテンプレートを生成できます。


{{% tab header="**Language**:" disabled=true /%}}
{{% tab header="Go" %}}

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

#### Go mod による取得

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

{{% /tab %}}
{{% tab header="PHP" %}}

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

#### Composerによる取得

[gs2-php-cdk](https://packagist.org/packages/gs2/gs2-php-cdk)

```shell
composer require gs2/gs2-php-cdk
```
{{% /tab %}}
{{% tab header="Java" %}}

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

#### Mavenによる取得

[gs2-java-cdk](https://central.sonatype.com/artifact/io.gs2/gs2-java-cdk)

{{% /tab %}}
{{% tab header="C#" %}}

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

#### NuGet による取得

[GS2.CSharp.Cdk](https://www.nuget.org/packages/GS2.CSharp.Cdk)
{{% /tab %}}
{{% tab header="Typescript" %}}

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

#### npmによる取得

[gs2-cdk](https://www.npmjs.com/package/gs2-cdk)

```shell
npm i gs2-cdk
```
{{% /tab %}}
{{% tab header="Python" %}}

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

#### PyPIによる取得

[gs2-cdk](https://pypi.org/project/gs2-cdk/)

```shell
pip install gs2-cdk
```
{{% /tab %}}


# SDKのインストールは終わりましたか？

次は、GS2 を実際に利用してみる [チュートリアル]() に挑戦してみましょう。




- [GS2 UIKit for Unity のチュートリアル](/ja/get_start/uikit/)
  
- [GS2-SDK for UE5 Blueprint のチュートリアル](/ja/get_start/blueprint/)
  
- [チュートリアル](/ja/get_start/tutorial/)