SDK の導入リファレンス

ゲームエンジンごとの SDK の導入方法をまとめた参照資料です。Unity で順に作って学ぶ場合は、冒険ゲームの開発環境を準備する から進められます。

Unreal Engine 5 と Godot のログイン実装例は、アカウント作成とログインのコード にまとめています。

GS2 SDK for Unityのインストール手順

GS2 SDK for Unity Installer Version 2024.4.1

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

新規で Unity プロジェクトを作成するか、既存の Unity プロジェクトを準備し、Unity Editor で開きます。

メニューの 『Assets > Import Package > Custom Package…』 から gs2-unity-installer_2024.4.1.unitypackage ファイルをインポートします。

Unity Editor のメニューから 『Window > Game Server Services > SDK Installer』 を選択します。

SDK インストーラーのウィンドウが表示されます。『Install』を選択します。

インストールが完了すると、プロジェクトの『Packages』にSDKがインストールされ、Package Managerでインストールされていることが確認できます。

GS2 SDK for Unity は GS2-CSharp-SDK と GS2 SDK for Unity で構成されています、

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

GS2 UIKit for Unityのインストール手順

Unity Editor のメニューから 『Window > Game Server Services > UIKit for Unity Installer』 を選択します。

インストールが完了すると、プロジェクトの『Packages』にSDKがインストールされ、Package Managerでインストールされていることが確認できます。

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

GS2 SDK for Unreal Engine 5 のインストール手順

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

新規で Unreal プロジェクトを作成するか、既存の Unreal プロジェクトを準備します。

GitHubの GS2 SDK for Unreal Engine 5 リポジトリ からソースコードをCloneします。

もしくはZip形式でダウンロードし、任意のフォルダーに展開します。

ソースコード一式を Unreal プロジェクトにコピーします。

Unreal プロジェクト内の以下のフォルダに配置してください。

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

Plugins フォルダが存在しない場合は新規作成してください。
Plugins フォルダ内に Gs2Plugin フォルダを作成し、その中にダウンロードしたファイル一式をコピーします。

Unreal Editor で uprojectファイルを起動します。

プラグイン ウィンドウを開き、GS2 プラグインにチェックをつけて有効化します。
Unreal Editor を再起動してください。

GS2プラグインのビルドを確認するダイアログが表示されますので、「はい」　を選びます。

環境によりますが、ビルドには相応の時間がかかります。
プラグインのビルドに成功すると Unreal Editorが起動します。

以上でインストールは完了です。

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

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

GitHubの GS2 SDK for Unreal Engine 5 リポジトリ からソースコードをCloneします。

もしくはZip形式でダウンロードし、任意のフォルダーに展開します。

Unreal Engineソースコード内に以下のフォルダを作成し、フォルダ内にダウンロードしたソースコード一式をコピーしてください。

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

GenerateProjectFiles.batを実行して プロジェクト ファイルを更新します。

UE5.sln ファイルを開き、Unreal Engineをビルドします。
ビルドが完了したら UnrealEditorを起動し、GS2プラグインを有効化後、UnrealEditorを再起動してください。

以上でインストールは完了です。

GS2 SDK for Godot のインストール手順

GS2 SDK for Godot は Godot 4（GDScript）向けの SDK です。

GitHub の GS2 SDK for Godot の最新のリリース から、Assets の「Source code (zip)」をダウンロードします。

ダウンロードした ZIP ファイルを任意のフォルダに展開します。

展開したファイルに含まれる addons/gs2 フォルダを Godot プロジェクトへコピーします。

Godot プロジェクト内の配置先は次のとおりです。

(Godot プロジェクト)/addons/gs2

addons フォルダが存在しない場合は新規作成してください。 Godot Editor でプロジェクトを開き、FileSystem ドックに res://addons/gs2/ が表示されればインストールは完了です。

リアルタイムルールコンパイラの入手

GS2-Realtime のルールを GDScript で書く場合は、ルールのビルドにリアルタイムルールコンパイラ（gs2-realtime-compiler）を使います。コンパイラは SDK と同じリリースの Assets で配布しています。

OS に合った ZIP ファイルを展開し、Godot のエディタ設定の gs2/realtime/compiler_path に、展開した実行ファイルの場所を設定します。SDK を更新したときは、同じリリースのコンパイラに入れ替えてください。

ルールの書き方とビルドの手順は GDScript でルールを書く を参照してください。