Skip to main content

Gamium Engine Unity SDK

Gamium Engine Unity SDK is located in the engine/unity folder from the source root.

Package Import​

Requirements​

  • Unity 2020.3.0f1 or later

Install the Unity Editor​

Please refer to Configure Project Requirements for requirements.
install latest version of Unity Hub and Unity 2020.3.47f1 with Android Build Support. Also, if you want to test iOS and your installation environment is macOS, please also install iOS Build Support too.

Open Unity project​

You need a project to open with the Unity Editor. If there is no Unity project, please use the sample Gamium Unity project.
or you can use your Unity project.

Find local source code path​

Clone the project on GitHub to local. The Gamium Engine Unity SDK is located in the engine/unity folder from the source root.

$ git clone https://github.com/dogu-team/gamium.git
$ cd engine/unity
$ pwd

Please remember the path output from pwd. This path is {gamium_engine_unity_local_path} which will be shown below.

Import the SDK into your project​

The Gamium Engine Unity SDK was developed according to the Unity Package Layout format. Unity supports importing local packages through the Package Manager, which allows you to import the Gamium Engine Unity SDK.
You can import local unity package through Unity project manifest file. The file is located at {your unity project}/Packages/manifest.json. Looking for the file and replace {gamium_engine_unity_local_path} with the path to the Gamium Engine source code path.

{
  "dependencies": {
    "com.dogu.gamium.engine.unity": "file:{gamium_engine_unity_local_path}"
  }
}
info

If you have any questions about local package import, please refer to Unity Package Manager.

Build and Run​

  • If you return to the unity editor the script will build itself with the phrase "Compiling C# Scripts".
  • After that, press Play button to check if it runs normally.