LootLocker
The BasicsGame SystemsContent ManagementPlayer Management
LootLocker
  • 📌The Basics
    • Getting Started
    • What is LootLocker?
    • Core Concepts
      • Players
      • Assets
      • Character Classes
      • API Types
      • Web Console
      • Stage & Live Environments
      • Glossary
    • Unity Quick Start
      • Install the SDK
      • Configure the SDK
      • Authenticate Your First Player
      • Update the SDK
    • Unreal Quick Start
      • Install & Configure the SDK
        • Older versions
      • Authenticate Your First Player
    • Godot Quick Start
      • Install the SDK
      • Configure the SDK
      • Authenticate Your First Player
      • Update the SDK
    • SDKs
    • Samples
      • Authentication Samples
      • Leaderboard Samples
      • Progression Samples
      • Player Samples
    • Launching Your Game
    • Support
      • Error Codes
      • Unreal Marketplace Plugin Support
  • 🎭Players
    • Overview
    • Authentication
      • How To
        • Guest Login
        • Steam
        • Apple
        • Apple Game Center
        • Google
        • Epic Games
        • PlayStation
        • Meta / Oculus
        • Xbox
        • Nintendo Switch
    • Files
      • How To
        • Manage Files in Web Console
        • Work with Files In-Game
    • Inventory
      • How To
        • Work with Player Inventory
    • Messages
      • How To
        • Configure Messages in Web Console
    • Names
      • How To
        • Work with Player Names
    • Player Manager
      • How To
        • Manage Players through Web Console
        • Manage Players In-Game
        • Use Player Operations
    • Unified Player Accounts
      • How To
        • Configure UPA in Web Console
        • Use Remote Login In-Game
        • Connect Identiy Provider to Player
        • External Provider Linking
        • Transition from Guest Login to Other Provider
        • Disconnect Identity Provider from Player
    • White Label Login
      • How To
        • Configure White Label Login
        • Create a New White Label User
        • Request User Verification
        • Handle Returning Users
        • Start a White Label Session
  • 🪙Commerce
    • Overview
    • Catalogs
      • How To
        • Configure Catalogs in LootLocker Console
        • List all Catalogs
        • Use Catalogs In-Game
        • Setup In-Game Store
    • Currencies
      • How To
        • Configure a Currency in Web Console
        • Use Currencies In-Game
    • DLC Management
      • How To
        • Configure DLC in Web Console
        • Use DLC In-Game
    • Entitlements
      • How To
        • Work with Entitlements In-Game
    • Real Money Purchases
      • How To
        • Configure In-App Purchase in Web Console
        • Make Purchases through Google Play Store
        • Make Purchases through Apple Store
        • Make Purchases through Steam Store
    • Virtual Purchases
    • Wallets
      • How To
        • Manage a Wallet in Web Console
        • Use Wallets In-Game
  • ⚔️Content
    • Overview
    • Assets
      • How To
        • Create & Configure an Asset
        • Organize & Search for Assets
        • Retrieve Assets In-Game
        • Set up Asset Storage Template
        • Check Grant Notifications
        • Set up a Game Config Asset
        • Create a Loot Box
        • Work with Loot Boxes In-Game
        • Create a Drop Table
        • Work with Drop Tables In-Game
        • Create a Rental Asset
        • Work with Rental Assets In-Game
    • User Generated Content (UGC)
      • How To
        • Create UGC In-Game
    • Twitch Drops
  • 🕹️Game Systems
    • Overview
    • Classes & Heroes
      • How To
        • Base Classes
        • Hero Classes
        • Implement Classes In-Game
        • Implement Heroes In-Game
    • Leaderboards
      • How To
        • Configure Leaderboard in Web Console
        • Use Player Leaderboards
        • Use Generic Leaderboards
        • Use Metadata to Store Additional Information
        • Use Scheduled Reset with Rewards
        • Use Leaderboards for Time Based Rankings
      • Leaderboard FAQ
      • GameMaker References
    • Feedback
      • How To
        • Manage Feedback Categories
        • Create Player Feedback
        • Create UGC Feedback
        • Create Game Feedback
        • View and Manage Feedback
    • Progressions
      • How To
        • Create a Progression
        • Game Progressions
        • Player Progressions
        • Class Progressions
        • Asset Instance Progressions
    • Triggers
      • How To
        • Setup a trigger in the Web Console
        • Invoke trigger from game
  • ⛓️Shared Systems
    • Overview
    • Metadata
      • How To
        • Add Metadata in Console
        • Fetch a Single Metadata In-Game
        • Fetch Metadata In-Game by Tags
        • Fetch Metadata In-Game from Multiple Sources
    • Notifications
      • How To
        • List Notifications and Mark as Read In-Game
  • 🗝️Admin
    • Settings
    • User Settings
    • Organization Settings
    • CORS Allowlist
  • ⭕️ Legacy
    • Deprecations
      • Unity SDK Deprecation Log
        • Version 2.1.5 - Migration to Open UPM
        • Version 2.0.0
      • Unreal SDK Deprecation Log
        • Version 4.0.0
        • Version 3.0.0
    • Legacy Storage
    • Legacy Triggers
      • Activate a trigger
      • Create a trigger
    • Legacy Progressions
      • Create a Progression System
      • Use a Progression System In-Game
Powered by GitBook
On this page
  • Install the SDK
  • Install from Unreal Marketplace
  • Install from Github Repository
  • Configure the SDK
  • Configure the SDK in Project Settings
  1. The Basics
  2. Unreal Quick Start

Install & Configure the SDK

Installing and configuring the LootLocker SDK in your Unreal project only takes a few minutes.

PreviousUnreal Quick StartNextOlder versions

Last updated 1 month ago

Install the SDK

Installing the LootLocker SDK in your project is very straightforward and flexible with different ways to set it up depending on engine version and personal preferences. Once you have downloaded the SDK, follow these steps to install the LootLocker SDK into your Unreal Engine project.

Install from Unreal Marketplace

In the Epic Games Launcher, search for LootLocker SDK, click on the LootLockerSDK and click Install to Engine.

If you were previously using the plugin as a project plugin, delete the LootLockerSDK folder under Plugins directory in your existing Unreal project.

Open your Unreal project in the Unreal Editor, navigate to Edit/Plugins in the menu and search for LootLockerSDK.

Tick Enabled, and the editor should prompt you to restart Unreal.

Once restarted, click on File->Refresh Visual Studio Project in the menu.

If you don't see "Refresh Visual Studio Project" in the File menu, click Tools->New C++ Class, select None, click Next, click Create Class, when compilation has finished you should see Refresh Visual Studio Project in the File menu.

If you don't see "Refresh Visual Studio Project" in the File menu, click File->New C++ Class, select None, click Next, click Create Class, when compilation has finished you should see Refresh Visual Studio Project in the File menu.

Click on File->Open Visual Studio.

Once the solution opens in Visual Studio, navigate to your projects Build.cs file located in; Games ->”ProjectName” -> Source -> “ProjectName” -> Source -> ProjectName.Build.cs

Add {“LootLockerSDK”} to the PublicDependencyModuleNames list (see example below).

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "LootLockerSDK" });

Add {“Http”, “Json”, “JsonUtilities”} to the PrivateDependencyModuleNames list (see example below).

PrivateDependencyModuleNames.AddRange(new string[] { "HTTP", "Json", "JsonUtilities" });

Continue to the next step of the tutorial to .

Install from Github Repository

Copy the LootLockerSDK folder to the Plugins folder at the root of your Unreal Project. If the Plugins folder does not exist yet, create it.

Right click the Unreal Engine Project Launch file in the root of the project and click Generate Visual Studio Project Files.

Open your project's .sln file.

Open your project's Build.cs file and add the following.

Add {“LootLockerSDK”} to the PublicDependencyModuleNames list (see example below).

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "LootLockerSDK" });

Add {“HTTP”, “Json”, “JsonUtilities”} to the PrivateDependencyModuleNames list (see example below).

PrivateDependencyModuleNames.AddRange(new string[] { "HTTP", "Json", "JsonUtilities" });

Configure the SDK

Configure the SDK in Project Settings

  1. In Unreal Engine, navigate to Edit/Project Settings and scroll down the left panel until you reach the Plugins section of the Project Settings. Click on LootLockerSDK.

  2. Modify the following information:

    • Game Version refers to the current version of your game in the format 1.2.3.4 (the 3 and 4 being optional but recommended).

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

Deprecated Properties

  • Platform is the name of the platform the game will be built for (e.g Steam, PSN, Android, iOS). This property has been deprecated and instead of using this, you should call the StartSession method for the platform you want to use.

If you update the plugin in the future you might need to repeat some of these steps.

You should now have access to the SDK in both your C++ and Blueprint projects.

Download or clone the so that you have it on disk.

Continue to the next step of the tutorial to .

Now that you have installed the SDK into your Unreal project, you will want to connect the Unreal project to your game in the LootLocker Web Console. The following steps walk you through configuring the LootLocker Unreal Engine SDK to work with a game that has already been created in the LootLocker Web Console. If you haven’t created a game or account yet, please visit or follow .

Login to the LootLocker Web Console by visiting and navigate to the Settings menu and the in order to copy the Domain and API Keys.

API Key is found in Game Settings in the .

Domain Key is found in Game Settings in the .

On Development Mode lets you test your unpublished changes in the LootLocker Management Console Stage environment (instead of Live). Checking this box will make the SDK target the Stage environment. If you want to understand this in more detail, check out the page . This property has been deprecated, instead use the corresponding api key. Stage keys begin with dev_ and Live keys begin with prod_.

📌
repository
console.lootlocker.com
this guide
console.lootlocker.com
API Keys section
LootLocker Web Console
LootLocker Web Console
Stage & Live Environments
configure the SDK in your project
configure the SDK in your project