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


# SDK installation reference

Install the GS2 SDK for Unity, Unreal Engine, and Godot




This reference covers SDK installation for each game engine. For the step-by-step Unity tutorial, start with [Prepare your adventure game development environment]().

For Unreal Engine 5 and Godot login examples, see [Account creation and login code]().

## Install GS2 SDK for Unity {#unity}

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

**Download the UnityPackage installer using the link above.**

**Create a Unity project or open an existing one in the Unity Editor.**

**Import gs2-unity-installer_2024.4.1.unitypackage through Assets > Import Package > Custom Package....**

<img src='/ja/get_start/sdk/unity_1.png' width='40%'>

**In the Unity Editor menu, choose Window > Game Server Services > SDK Installer.**

<img src='/ja/get_start/sdk/unity_2.png' width='40%'>

**In the SDK Installer window, click Install.**

<img src='/ja/get_start/sdk/unity_3.png' width='50%'><br>

<img src='/ja/get_start/sdk/unity_4.png' width='50%'>

Once installation finishes, the SDK appears under the project's Packages. You can also confirm it in Package Manager.

<img src='/ja/get_start/sdk/unity_5.png' width='60%'>

The Unity SDK consists of GS2-CSharp-SDK and GS2 SDK for Unity.

If it does not work correctly after installation, try restarting the Unity Editor.

### Install GS2 UIKit for Unity {#uikit}

<img src='/ja/get_start/sdk/unity_6.png' width='40%'>

**In the Unity Editor menu, choose Window > Game Server Services > UIKit for Unity Installer.**

<img src='/ja/get_start/sdk/unity_7.png' width='50%'><br>

<img src='/ja/get_start/sdk/unity_8.png' width='50%'>

Once installation finishes, the SDK appears under the project's Packages. You can also confirm it in Package Manager.

<img src='/ja/get_start/sdk/unity_9.png' width='60%'>

If it does not work correctly after installation, try restarting the Unity Editor.

## Install GS2 SDK for Unreal Engine 5

### Install as a project plugin {#ue-project}

**Create an Unreal project or prepare an existing one.**
<img src='/ja/get_start/sdk/ue_1.png' width='60%'>

**Clone the [GS2 SDK for Unreal Engine 5 repository on GitHub](https://github.com/gs2io/gs2-sdk-for-ue5).**

<img src='/ja/get_start/sdk/ue_2.png' width='30%'>

Alternatively, download a ZIP and extract it to a folder.

<img src='/ja/get_start/sdk/ue_3.png' width='30%'>

**Copy the source files into the Unreal project.**

<img src='/ja/get_start/sdk/ue_4.png' width='100%'>

Use the following folder inside the Unreal project.

```
(Unreal project)/Plugins/Gs2Plugin
```

Create a Plugins folder if it does not exist.<br>
Create a `Gs2Plugin` folder inside Plugins and copy all the downloaded files into it.

**Open the uproject file in Unreal Editor.**

Open the Plugins window and enable the GS2 plugin.<br>
Restart Unreal Editor.

<img src='/ja/get_start/sdk/ue_5.png' width='60%'>

**When prompted to build the GS2 plugin, choose Yes.**

<img src='/ja/get_start/sdk/ue_6.png' width='35%'>

The build can take some time, depending on your environment.<br>
Unreal Editor starts once the plugin builds successfully.

Installation is complete.

### Install as an engine plugin {#ue-engine}

If you build Unreal Engine from source obtained through GitHub or Perforce, you can install the SDK as an engine plugin.

**Clone the [GS2 SDK for Unreal Engine 5 repository on GitHub](https://github.com/gs2io/gs2-sdk-for-ue5).**

<img src='/ja/get_start/sdk/ue_2.png' width='30%'>

Alternatively, download a ZIP and extract it to a folder.

<img src='/ja/get_start/sdk/ue_3.png' width='30%'>

**Create the following folder inside the Unreal Engine source tree and copy all downloaded source files into it.**

```
(Unreal Engine source)/Engine/Plugins/Gs2Plugin
```

<img src='/ja/get_start/sdk/ue_7.png' width='90%'>

**Run GenerateProjectFiles.bat to update the project files.**

Open UE5.sln and build Unreal Engine.<br>
After the build, start Unreal Editor, enable the GS2 plugin, and restart the editor.

<img src='/ja/get_start/sdk/ue_8.png' width='60%'>

Installation is complete.

## Install GS2 SDK for Godot {#godot}

GS2 SDK for Godot supports Godot 4 (GDScript).

**From the [latest GS2 SDK for Godot release on GitHub](https://github.com/gs2io/gs2-sdk-for-godot/releases/latest), download Source code (zip) under Assets.**

Extract the ZIP to a folder.

**Copy the extracted `addons/gs2` folder into your Godot project.**

Place it at the following location in the Godot project.

```text
(Godot project)/addons/gs2
```

Create the `addons` folder if it does not exist.
Open the project in Godot Editor. Installation is complete when `res://addons/gs2/` appears in the FileSystem dock.

### Get the Realtime rule compiler {#realtime-compiler}

To write GS2-Realtime rules in GDScript, build them with the Realtime rule compiler (`gs2-realtime-compiler`). The compiler is distributed in the Assets of the same SDK release.

| File | OS |
|---|---|
| `gs2-realtime-compiler-win-x64.zip` | Windows（x64） |
| `gs2-realtime-compiler-osx-arm64.zip` | macOS (Apple silicon) |
| `gs2-realtime-compiler-osx-x64.zip` | macOS（Intel） |
| `gs2-realtime-compiler-linux-x64.zip` | Linux（x64） |

Extract the ZIP for your OS and set `gs2/realtime/compiler_path` in Godot's editor settings to the extracted executable. When updating the SDK, use the compiler from the same release.

For rule authoring and build steps, see [Write rules in GDScript]().




- [Login examples for Unreal Engine and Godot](/en/get_start/sdk/login/)