Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 4.37 KB

README.md

File metadata and controls

80 lines (58 loc) · 4.37 KB
Raw

LootLocker Unity SDK

LootLocker

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

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 or our official documentation.

From Git

Before you start you need to have git 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.

Configuration

For a full walkthrough of how to configure the SDK, please see our Guide to Configuring the Unity 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

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.

Support

If you have any issues or just wanna chat you can reach us on our Discord Server

Development

Testing the SDK

Status: Test SDK with Unity

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:

{
  "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).