|
1 | 1 | <h1 align="center">LootLocker Unity SDK</h1>
|
2 | 2 |
|
3 | 3 | <h1 align="center">
|
4 |
| - <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> |
| 4 | + <a href="https://www.lootlocker.com/"><img src="https://s3.eu-west-1.amazonaws.com/cdn.lootlocker.io/public/lootLocker_wide_dark_whiteBG.png" alt="LootLocker"></a> |
5 | 5 | </h1>
|
6 | 6 |
|
7 | 7 | <p align="center">
|
8 | 8 | <a href="#about">About</a> •
|
9 |
| - <a href="#Installation">Installation</a> • |
| 9 | + <a href="#installation">Installation</a> • |
10 | 10 | <a href="#configuration">Configuration</a> •
|
11 | 11 | <a href="#updating">Updating</a> •
|
12 | 12 | <a href="#support">Support</a> •
|
13 |
| - <a href="#Development">Development</a> |
| 13 | + <a href="#development">Development</a> |
14 | 14 | </p>
|
15 | 15 |
|
16 | 16 | ---
|
17 | 17 |
|
18 | 18 | ## About
|
19 |
| - |
20 | 19 | LootLocker is a game backend-as-a-service that unlocks cross-platform systems so you can build, ship, and run your best games.
|
21 | 20 |
|
22 |
| -Full documentation is available here https://docs.lootlocker.io/getting-started/unity-tutorials |
| 21 | +Full documentation is available here https://docs.lootlocker.com/ |
23 | 22 |
|
24 | 23 | ## Installation
|
25 | 24 |
|
26 |
| -### Using Git |
| 25 | +### From Open UPM [](https://openupm.com/packages/com.lootlocker.lootlockersdk/) |
| 26 | +The **preferred way** of installing the LootLocker SDK is through Open UPM. This way you will receive future updates in a streamlined way. Please refer to OpenUPM for their [simple install instructions](https://openupm.com/packages/com.lootlocker.lootlockersdk/#modal-manualinstallation) or our [official documentation](https://docs.lootlocker.com/the-basics/unity-quick-start/install-the-sdk). |
27 | 27 |
|
28 |
| -Before you start, Git should be installed on your computer, Mac users should have this automatically, for windows you can use for example [Git for Windows](https://gitforwindows.org/). Quick note: You might need to restart Unity and/or your computer before Unity recognizes you’ve installed Git. |
| 28 | +### From Git |
| 29 | +Before you start you need to have [git](https://git-scm.com/) installed on your computer. |
29 | 30 |
|
30 | 31 | - In the Unity Editor go to `Window > Package Manager`
|
31 | 32 | - Click the + at the top left of the Package Manager window
|
32 | 33 | - Select `Add package from git URL...`
|
33 | 34 | - Paste the following URL `https://github.com/LootLocker/unity-sdk.git` and click `Add`
|
34 | 35 |
|
35 |
| -### Using the Entire Repo |
36 |
| - |
37 |
| -- Download the code from here by choosing `Code` and then `Download Zip` |
38 |
| -- Unzip the files and place them in a folder in the Packages folder of your Unity Project |
| 36 | +### Other install methods |
| 37 | +For other methods, please refer to our [official documentation](https://docs.lootlocker.com/the-basics/unity-quick-start/install-the-sdk). |
39 | 38 |
|
40 | 39 | ## Configuration
|
| 40 | +For a full walkthrough of how to configure the SDK, please see our [Guide to Configuring the Unity SDK](https://docs.lootlocker.com/the-basics/unity-quick-start/configure-the-sdk). But here's a short explanation: |
41 | 41 |
|
42 |
| -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) |
43 |
| - |
44 |
| -### For a short version |
| 42 | +### Using the LootLocker Unity Extension (since Unity v2021) |
| 43 | +- Open the LootLocker Extension in Unity (Windows > LootLocker) |
| 44 | +- Sign in with your LootLocker account |
| 45 | +- Select your game, environment, and game key. |
45 | 46 |
|
46 |
| -- Log on to the [LootLocker management console](https://my.lootlocker.io/login) and find your Game Settings. |
47 |
| -- Find your Game Key in the API section of the settings |
| 47 | +### Configuring the SDK manually |
| 48 | +- Log on to the [LootLocker management console](https://console.lootlocker.com/login) and find your Game Settings. |
| 49 | +- Find your Game Key in the [API section of the settings](https://console.lootlocker.com/settings/api-keys) |
48 | 50 | - Open `Edit > Project Settings` in the Unity Editor and find the `LootLocker SDK` tab.
|
49 | 51 | - Input Api Key using the Game Key from the LootLocker console page
|
50 | 52 |
|
51 | 53 | ## Updating
|
| 54 | +If you have installed the SDK from Open UPM then all you have to do in Package Manager is press the Update button when that tells you there's a new version. |
52 | 55 |
|
53 |
| -If you installed the SDK using the Git URL you can simply open the package manager and re-paste the Git URL. |
54 |
| -This should force a download of the latest code. |
| 56 | +For other install methods and more information, head over to our [official documentation](https://docs.lootlocker.com/the-basics/unity-quick-start/updating-sdk). |
55 | 57 |
|
56 | 58 | ## Support
|
57 |
| - |
58 | 59 | If you have any issues or just wanna chat you can reach us on our [Discord Server](https://discord.lootlocker.io/)
|
59 | 60 |
|
60 | 61 | ## Development
|
61 | 62 |
|
62 | 63 | ### Testing the SDK
|
63 |
| - |
64 |
| -Status: [](https://github.com/LootLocker/unity-sdk/actions/workflows/main.yml) |
| 64 | +Status: [](https://github.com/LootLocker/unity-sdk/actions/workflows/run-tests-and-package.yml?query=branch%3Amain) |
65 | 65 |
|
66 | 66 | There is a Test Suite for the SDK, but it is in an [external repo](https://github.com/LootLocker/unity-sdk-tests) to keep the size of this one down. It is run automatically on any pull requests towards or updates to main. You can also run it locally, just follow the steps in the test repo.
|
0 commit comments