InventoryFramework.UnityAdapter 1.0.3

InventoryFramework.UnityAdapter

Unity integration for InventoryFramework — a server-authoritative inventory and crafting backend. Wraps the gRPC SDK in a MonoBehaviour-friendly facade so you spend zero time on transport code.

Requirements

• Unity 2021.3 LTS or later
• .NET Standard 2.1 scripting backend
• A running InventoryFramework server

Installation

dotnet add package InventoryFramework.UnityAdapter

Or copy the DLLs from dist/unity/ into Assets/Plugins/.

Setup

using InventoryFramework.UnityAdapter.Models;
using InventoryFramework.UnityAdapter.Services;

public class InventoryManager : MonoBehaviour
{
    private UnityInventoryFacade _facade;

    private async void Start()
    {
        _facade = new UnityInventoryFacade(new UnityInventoryConfiguration
        {
            ServerAddress = "https://your-server:7289",
            ActorId       = SystemInfo.deviceUniqueIdentifier,
            ApiKey        = "sk-game-your-key"
        });

        await _facade.CreateDefaultInventoryAsync();
        await _facade.RefreshAsync();
    }

    private void OnDestroy() => _facade?.Dispose();
}

Common operations

// Grant items (admin)
await _facade.GrantItemsAsync(containerId, "wood", 10);

// One-button quick-store (backpack → chest)
await _facade.QuickStoreToTargetContainerAsync(sourceId, targetId);

// Craft with station check
var preview = await _facade.PreviewCraftItemsAsync("plank_recipe", sourceId, targetId, count: 3, station: "workbench");
if (preview.CanCraftRequestedCount)
    await _facade.CraftItemsAsync("plank_recipe", sourceId, targetId, count: 3, allowPartial: false, station: "workbench");

// Transfer a slot
await _facade.TransferItemsAsync(sourceId, slotIndex: 0, targetId, quantity: 5);

// Lock a slot (skipped by quick-store and sort)
await _facade.LockSlotAsync(containerId, slotIndex: 2, lockSlot: true);

// Split a stack into two slots
var split = await _facade.SplitStackAsync(containerId, sourceSlotIndex: 0, amount: 5);
Debug.Log($"Split landed in slot {split.DestinationSlotIndex}");

// Drop items (optionally spawn a world pickup)
var drop = await _facade.DropItemsAsync(containerId, slotIndex: 0, amount: 3);
if (drop.Succeeded) SpawnWorldPickup(drop.DroppedItemDefinitionId, drop.DroppedQuantity);

// Sort container (0 = ByNameAscending, 1 = ByWeightDescending, 2 = ByTagThenName)
await _facade.SortContainerAsync(containerId, sortMode: 0);

// Read current inventory state
var snapshot = _facade.CurrentSnapshot;
foreach (var slot in snapshot.Containers[0].Slots.Where(s => !s.IsEmpty))
    Debug.Log($"{slot.ItemDefinitionId} x{slot.Quantity} — durability: {slot.CurrentDurability}");

Session controller

For longer sessions with UI data binding:

var controller = new UnityInventorySessionController(_facade);
await controller.StartSessionAsync();
// controller.State.Snapshot  — current inventory
// controller.State.IsConnected

Full documentation: Unity Integration Guide