Amanotes GDK

AmaGDK Dev Project Setup

Clone Project From GitLab

1. Clone project from GitLab url: https://gitlab.amanotes.net/sdk/AmaSDK_v5
2. Open terminal windows and cd to your project
3. Run file create-links.sh (Link GDK folder children to GDKDev)

How To Open Project

• Open project GDKDev

Main folder

• AmaGDK: adapters logic, example, installer, configs

• AmaGDKCore: core logic, packages

• AmaGDKDev: tools for dev as build tool, release tool

• AmaGDKTest: scenes test, unit test

Switch To Dev Mode

1. Add GDK_HOME variable to .zshrc file in Mac OS

• Step 1: Open terminal, input sudo nano ~/.zshrc

• Step 2: Enter and input password, add new line export GDK_HOME=/AmaGDKCoreFolderPath

• Step 3: Press Ctr+X buttons -> Press Y button -> Press Enter button to save

2. Select AmaGDK prefab in scene → select Change Dev Mode in context menu

Code Convention

Convention

Links Reference

Reference

Getting started with AmaGDK

Add AmaGDK prefab to your bootstrap scene (the first scene in your game build settings)

There are two ways to do:

1. Drag and drop the AmaGDK prefab from Packages/AmaGDK/Runtime to the hierachy window
2. Right click on the hierachy window, find and click AmaGDK to add it to the scene

Usage

Import namespace

using Amanotes.Core;

Get your service

Each service is a subclass of AmaGDK class. For example, logging event is an activity of analytics. We do:

using Amanotes.Core;

public class YourGameSceneController
{
    void DemoLogging()
    {
        AmaGDK.Analytics.LogEvent("demo_event");        
    }
}

Versioning

We use SemVer for versioning.

License

This project is licensed under the MIT License - see the LICENSE.md file for details