LootLocker Unity SDK

About • Installation • Configuration • Updating • Support • Development

--- ## About LootLocker is a game backend-as-a-service that unlocks cross-platform systems so you can build, ship, and run your best games. Full documentation is available here https://docs.lootlocker.com/ ## Installation ### From Open UPM [![openupm](https://camo.githubusercontent.com/0bd309b8c734226357776c69b3ef0b59c8db542a7e0b016913503c73c0b6510e/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f636f6d2e6c6f6f746c6f636b65722e6c6f6f746c6f636b657273646b3f6c6162656c3d6f70656e75706d2672656769737472795f7572693d68747470733a2f2f7061636b6167652e6f70656e75706d2e636f6d)](https://openupm.com/packages/com.lootlocker.lootlockersdk/) 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). ### From Git Before you start you need to have [git](https://git-scm.com/) installed on your computer. - In the Unity Editor go to `Window > Package Manager` - Click the + at the top left of the Package Manager window - Select `Add package from git URL...` - Paste the following URL `https://github.com/LootLocker/unity-sdk.git` and click `Add` ### Other install methods For other methods, please refer to our [official documentation](https://docs.lootlocker.com/the-basics/unity-quick-start/install-the-sdk). ## Configuration 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: ### Using the LootLocker Unity Extension (since Unity v2021) - Open the LootLocker Extension in Unity (Windows > LootLocker) - Sign in with your LootLocker account - Select your game, environment, and game key. ### Configuring the SDK manually - Log on to the [LootLocker management console](https://console.lootlocker.com/login) and find your Game Settings. - Find your Game Key in the [API section of the settings](https://console.lootlocker.com/settings/api-keys) - Open `Edit > Project Settings` in the Unity Editor and find the `LootLocker SDK` tab. - Input Api Key using the Game Key from the LootLocker console page ## Updating 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. For other install methods and more information, head over to our [official documentation](https://docs.lootlocker.com/the-basics/unity-quick-start/updating-sdk). ## Support If you have any issues or just wanna chat you can reach us on our [Discord Server](https://discord.lootlocker.io/) ## Development ### Testing the SDK Status: To set up the tests, you must add our package to the manifest.json `testables` underneath `dependencies`. Your manifest.json should look something like this: ```json { "dependencies": { "com.lootlocker.lootlockersdk": "https://github.com/lootlocker/unity-sdk.git", many more dependencies... }, "testables": ["com.lootlocker.lootlockersdk"] } ``` Once you have done this, you can go into Unity and go to `Window` -> `General` -> `Test Runner`. This will open a new window which should already include all the tests available, Then all you have to do is press `Run All` and the tests will begin. If you are running the tests towards the LootLocker production environment you will need to provide a username and password to an existing user either by setting the values directly in LootLockerTestConfigurationUser::GetProductionUser or via command line arguments -adminemail and -adminpassword. Bear in mind that your tests will be rate limited when running towards production (and in general this is a bad idea).