Skip to content

Commit d7f9b8e

Browse files
Erik Bylundkirre-bylund
authored andcommitted
Update readme to adhere to the move to open upm
1 parent 6158e1b commit d7f9b8e

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,66 @@
11
<h1 align="center">LootLocker Unity SDK</h1>
22

33
<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>
55
</h1>
66

77
<p align="center">
88
<a href="#about">About</a> •
9-
<a href="#Installation">Installation</a> •
9+
<a href="#installation">Installation</a> •
1010
<a href="#configuration">Configuration</a> •
1111
<a href="#updating">Updating</a> •
1212
<a href="#support">Support</a> •
13-
<a href="#Development">Development</a>
13+
<a href="#development">Development</a>
1414
</p>
1515

1616
---
1717

1818
## About
19-
2019
LootLocker is a game backend-as-a-service that unlocks cross-platform systems so you can build, ship, and run your best games.
2120

22-
Full documentation is available here https://docs.lootlocker.io/getting-started/unity-tutorials
21+
Full documentation is available here https://docs.lootlocker.com/
2322

2423
## Installation
2524

26-
### Using Git
25+
### From Open UPM [![openupm](https://img.shields.io/npm/v/com.lootlocker.lootlockersdk?label=openupm&registry_uri=https://package.openupm.com)](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).
2727

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.
2930

3031
- In the Unity Editor go to `Window > Package Manager`
3132
- Click the + at the top left of the Package Manager window
3233
- Select `Add package from git URL...`
3334
- Paste the following URL `https://github.com/LootLocker/unity-sdk.git` and click `Add`
3435

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).
3938

4039
## 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:
4141

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.
4546

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)
4850
- Open `Edit > Project Settings` in the Unity Editor and find the `LootLocker SDK` tab.
4951
- Input Api Key using the Game Key from the LootLocker console page
5052

5153
## 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.
5255

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).
5557

5658
## Support
57-
5859
If you have any issues or just wanna chat you can reach us on our [Discord Server](https://discord.lootlocker.io/)
5960

6061
## Development
6162

6263
### Testing the SDK
63-
64-
Status: [![Test SDK with Unity](https://github.com/LootLocker/unity-sdk/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/LootLocker/unity-sdk/actions/workflows/main.yml)
64+
Status: [![Test SDK with Unity](https://github.com/LootLocker/unity-sdk/actions/workflows/run-tests-and-package.yml/badge.svg?branch=main)](https://github.com/LootLocker/unity-sdk/actions/workflows/run-tests-and-package.yml?query=branch%3Amain)
6565

6666
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

Comments
 (0)