Skip to content

Commit c092419

Browse files
committed
added back readme
1 parent 06ed453 commit c092419

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# unity-sdk
2+
Full documentation available here https://docs.lootlocker.io/unity-sdk/
3+
4+
## Installation
5+
6+
The following steps outline how to install the LootLocker SDK into your Unity project.
7+
8+
1. Download the latest Unity Package Release from the [Github](https://github.com/LootLocker/unity-sdk) repository or from the [Unity Asset Store](https://assetstore.unity.com/packages/slug/180099)**.**
9+
2. Double-click on the package or drag the package into your Unity scene to import it.
10+
3. LootLocker requires “Editor Coroutine” from the package manager to function properly. If you currently have this in your project you can click exit in the window that displays after importing.
11+
Note: If you imported from github release and not Unity. You might need to open the package manager and install "Editor Coroutine". Otherwise project might not compile.
12+
4. If you are importing the package into an already existing project, please untick the project settings so your settings are not overwritten.
13+
5. If you already have the package “JsonDotNet” or “NewtonJson” from the Unity Asset Store or Github, please untick the “Dependencies” folder
14+
6. Click import to complete the SDK installation
15+
16+
**Note**: If you do not intend to use the Admin SDK, Unity Samples or Sample App, you can safely delete the folders within the LootLocker folder to reduce the size of the project.
17+
18+
## Set Up
19+
20+
Now that you have installed the SDK into your Unity project, you will want to connect the Unity project to your game in the LootLocker Management Console.
21+
22+
The following steps walks you through configuring the LootLocker Unity SDK to work with a game that has been created in the LootLocker Management Console at [my.lootlocker.io](https://my.lootlocker.io)
23+
24+
There are two methods for setting up the SDK: using the Admin SDK or by manually editing the config file.
25+
26+
### Using the Admin SDK
27+
28+
The Admin SDK is provided as a simple tool to login to your LootLocker account and configure your Unity project to a game you have set up in the LootLocker Management Console.
29+
30+
1. Navigate to the menu bar and select Window/Open LootLocker Admin Panel.
31+
2. Enter the email and password for your LootLocker account. If you do not have a LootLocker account you can create one by visiting [lootlocker.io/sign-up](https://www.lootlocker.io/sign-up).
32+
3. In the LootLocker Admin Panel, select the game you wish to use.
33+
4. In the Project view, navigate to LootLocker/Game/Resources/Config.
34+
5. Click on LootLockerConfig.
35+
6. Modify your the following:
36+
1. Game Version e.g 1.0.0.0
37+
2. Platform e.g Android, Steam
38+
3. Environment e.g Development
39+
You are now ready to use LootLocker and connect to your game's APIs.
40+
41+
### Modifying the Config
42+
43+
Alternatively, you can configure your Unity project manually by excluding the Admin SDK from the installation.
44+
45+
1. Login to the LootLocker Management Console by visiting [my.lootlocker.io](https://my.lootlocker.io)
46+
2. Click on Settings
47+
3. Copy your Game Name and API Key
48+
4. Return to Unity
49+
5. In the Project view, navigate to LootLocker/Game/Resources/Config
50+
6. Fill in all information based on data from the LootLocker Settings Menu
51+
1. Game Version e.g 1.0.0.0
52+
2. Platform e.g Android, Steam
53+
3. Environment e.g Development
54+
55+
You are now ready to use LootLocker and connect to your game's APIs.

0 commit comments

Comments
 (0)