Skip to content

Commit 1f504bb

Browse files
committed
Add new README
1 parent debf476 commit 1f504bb

File tree

1 file changed

+39
-34
lines changed

1 file changed

+39
-34
lines changed

README.md

Lines changed: 39 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,59 @@
1-
# unity-sdk
2-
Full documentation available here https://docs.lootlocker.io/getting-started/unity-tutorials
1+
# LootLocker Unity SDK
32

4-
## Install from Unity Package Manager (Recommended)
3+
<h1 align="center">
4+
<br>
5+
<a href="https://www.lootlocker.io/"><img src="https://s3.eu-west-1.amazonaws.com/cdn.lootlocker.io/public/lootLocker_wide_dark_whiteBG.png" alt="LootLocker"></a>
6+
</h1>
57

6-
### Using GIT
8+
<p align="center">
9+
<a href="#about">About</a> •
10+
<a href="#Installation">Installation</a> •
11+
<a href="#configuration">Configuration</a> •
12+
<a href="#updating">Updating</a> •
13+
<a href="#support">Support</a>
14+
</p>
715

8-
Before you start, make sure you have git installed on your computer.
9-
Open the Unity editor and navigate to the Package Manager by clicking on Window and then Package Manager.
16+
---
1017

11-
Click on the + at the top of the Package Manager window and select Add package from git URL.
18+
## About
1219

13-
Enter the URL below into the text box and click Add.
14-
https://github.com/LootLocker/unity-sdk.git
20+
LootLocker is a game backend-as-a-service that unlocks cross-platform systems so you can build, ship, and run your best games.
1521

16-
The SDK is now installed in your project, and you are ready to configure the SDK and make your first API calls.
22+
Full documentation is available here https://docs.lootlocker.io/getting-started/unity-tutorials
1723

18-
### Using the Entire Repo
19-
20-
If you do not have git installed on your computer. You can install the SDK by downloading the entire repository and pasting in the packages folder of your project.
21-
You can download the entire repo by clicking Code and Download Zip
22-
23-
The SDK is now installed in your project, and you are ready to configure the SDK and make your first API calls.
24+
## Installation
2425

25-
## Configure the SDK
26+
### Using Git
2627

27-
It’s time to connect the SDK in your project to the LootLocker Management Console. Depending on the game engine, there might be different ways to achieve this, so make sure you read everything before getting started.
28-
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. The following steps walk you through configuring the LootLocker Unity SDK to work with a game that has already been created in the LootLocker Management Console. If you haven’t created a game or account yet, please visit my.lootlocker.io or follow this guide.
29-
There are two methods for setting up the SDK: setting it up manually in the project settings in the editor or using the Admin SDK. This tutorial will explain both ways.
28+
Before you start, Git should be installed on your PC.
29+
We recommend using [Git for Windows](https://gitforwindows.org/)
3030

31-
### Configure via Project Settings
32-
Login to the LootLocker Management Console by visiting my.lootlocker.io.
31+
- In the Unity Editor go to `Window > Package Manager`
32+
- Click the + at the top left of the Package Manager window
33+
- Select `Add package from git URL...`
34+
- Paste the following URL `https://github.com/LootLocker/unity-sdk.git` and click `Add`
3335

34-
Click on Game Settings and copy your API Key.
35-
36-
Return to the Unity Editor, Click on Edit, and then Project Settings.
36+
### Using the Entire Repo
3737

38-
Click on LootLocker SDK in the list to the left and fill in your API Key copied from the LootLocker dashboard.
38+
- Download the code from here by choosing `Code` and then `Download Zip`
39+
- Unzip the files and place them in a folder in the Packages folder of your Unity Project
3940

40-
Fill in all information based on data from the LootLocker Settings Menu.
41+
## Configuration
4142

42-
API Key is found in Game Settings in the LootLocker Management Console.
43+
For a full walkthrough of how to configure the SDK, please see our [Guide to Configuring the Unity SDK](https://docs.lootlocker.io/getting-started/unity-tutorials/getting-started-with-unity/configure-the-sdk)
4344

44-
Game Version refers to the current version of the game in the format 1.2.3.4 (the 3 and 4 being optional but recommended).
45+
### For a short version
4546

46-
Platform is the name of the platform the game will be built for (e.g Steam, PSN, Android, iOS).
47+
- Log on to the [LootLocker management console](https://my.lootlocker.io/login) and find your Game Settings.
48+
- Find your Game Key in the API section of the settings
49+
- Open `Edit > Project Settings` in the Unity Editor and find the `LootLocker SDK` tab.
50+
- Input Api Key using the Game Key from the LootLocker console page
4751

48-
Environment lets you test your unpublished changes in the LootLocker Management Console by selecting Development instead of Live.
52+
## Updating
4953

50-
Current Debug Level allows you to configure the debug level of the SDK. This can be set to Errors Only, Normal Only, or Off.
54+
If you installed the SDK using the Git URL you can simply open the package manager and re-paste the Git URL.
55+
This should force a download of the latest code.
5156

52-
Allow Token Refresh can be selected so that the SDK automatically attempts to refresh the session token if it expires. Otherwise the session token needs to be renewed manually.
57+
## Support
5358

54-
You have now configured the LootLocker SDK. In the next section you will learn how to make your first API calls.
59+
If you have any issues you can reach us on our [Dicord Server](https://discord.lootlocker.io/)

0 commit comments

Comments
 (0)