Skip to content
LootLockerLootLocker

Create User Generated Content In-Game

This how-to creates a UGC Asset Candidate, adds information to it, and promotes it to an Asset that other players can see in your game.

Prerequisites

  • Unity, Unreal, or Godot SDK installed and configured in your project (not required for REST).
  • An active Player session (see Authentication).
  • (Optional) A Context for the new UGC item. If you don't provide one, LootLocker assigns a default Context.

Create an Asset Candidate

The first thing a player does is create an Asset Candidate, the "working state" of UGC in LootLocker.

// Name is required when creating an asset candidate
string name = "New Asset Candidate";


// The below additional variables are optional
Dictionary<string, string> kv_storage = new Dictionary<string, string>();
kv_storage.Add("key", "value"); // Optional
Dictionary<string, string> filters = new Dictionary<string, string>();
filters.Add("key", "value"); // Optional
Dictionary<string, string> data_entities = new Dictionary<string, string>();
filters.Add("data", "name"); // Optional
int context_id = -1; // Optional


string asset_candidate_id = "";
LootLockerSDKManager.CreatingAnAssetCandidate(name, kv_storage, filters, data_entities, (response) =>
{
    if (response.success)
    {
        Debug.Log("Successfully created asset candidate with ID: " + response.asset_candidate_id);
        // Save the asset_candidate_id for future requests
        asset_candidate_id = response.asset_candidate_id;
    }
    else
    {
        Debug.Log("Error creating asset candidate");
    }
});

See the Reference Documentation for a list of supported properties.

Modify an Asset Candidate

After creating an Asset Candidate, you can modify it in several ways.

Delete an Asset Candidate

int assetCandidateID = 13;
LootLockerSDKManager.DeletingAnAssetCandidate(assetCandidateID, (response) =>
{
    if (response.success)
    {
        Debug.Log("Successfully deleted asset candidate");
    }
    else
    {
        Debug.Log("Error deleting asset candidate");
    }
});

Add Files to an Asset Candidate

int assetCandidateID = 12;
string filePath = "Assets/Resources/300.jpg";
string fileName = "300.jpg";
LootLocker.LootLockerEnums.FilePurpose fileType = LootLocker.LootLockerEnums.FilePurpose.primary_thumbnail;
LootLockerSDKManager.AddingFilesToAssetCandidates(assetCandidateID, filePath, fileName, fileType, (response) =>
{
    if (response.success)
    {
        Debug.Log("Successfully added image to asset candidate");
    }
    else
    {
        Debug.Log("Error adding image to asset candidate");
    }
});

Remove Files from an Asset Candidate

int assetCandidateID = 12;
int fileID = 1;
LootLockerSDKManager.RemovingFilesFromAssetCandidates(assetCandidateID, fileID, (response) =>
{
    if (response.success)
    {
      Debug.Log("Successfully removed file from asset candidate");
    }
    else
    {
      Debug.Log("Error removing file from asset candidate");
    }
});

Update an Asset Candidate

bool isCompleted = false;
// When updating an asset, all properties are optional.
// Empty fields are also updated, only update the ones that you want to replace
string name = "New Name"; // Optional
Dictionary<string, string> kv_storage = new Dictionary<string, string>();
kv_storage.Add("key", "value"); // Optional
Dictionary<string, string> filters = new Dictionary<string, string>();
filters.Add("key", "value"); // Optional
Dictionary<string, string> data_entities = new Dictionary<string, string>();
filters.Add("data", "name"); // Optional
int context_id = -1; // Optional
LootLockerSDKManager.UpdatingAnAssetCandidate(asset_candidate_id, isCompleted, (response) =>
{
    if (response.success)
    {
        Debug.Log("Successfully updated asset candidate with ID: " + response.asset_candidate.id);
    }
    else
    {
        Debug.Log("Error updating asset candidate");
    }
}, name, kv_storage, filters, data_entities, context_id);

When you're satisfied with the changes to the Asset Candidate, call UpdatingAnAssetCandidate() again with isCompleted set to true, and the Asset Candidate is promoted to a UGC Asset visible to all your players.

Conclusion

You've created a UGC Asset Candidate, added information to it, and promoted it to an Asset. If UGC moderation is enabled in your game, the new Asset appears in the UGC moderation tab in the Web Console for you to review. If moderation is disabled, the Asset is available immediately to your players through any of the ListAssets() functions. Consider also giving players a way to report UGC content they encounter.