Demo Walkthrough

Let's walk through how the demo was created.

This walkthrough is outdated but still valid. It will be updated soon.

How It Was Created

We'll walk through the steps for how the demo scene was created. Hopefully these steps will help you understand how you can achieve a similar result in your own project.

Step 0: Have a Scene Handy!

Create or use an existing scene with a player character that can move around. The demo uses Unity's starter assets and robot Kyle for demonstration purposes.

Step 1: Create Items, Crafts, Enchantments

Open the Inventool window from Window > Inventool > Inventool and create some items, crafts, and set enchantments that will be available in-game.

Step 2: Add Initializer and UI

Right click the hierarchy, navigate to Inventool, and select both the Initializer and your preferred UI option. This will add Inventool's UI and the initializer component in your scene.

Step 3: Add Input Support

In the character controller input actions asset, add the Inventory, Interact, and Exit actions. If you're using the split UI, you may need separate buttons for the inventory, key items, and equipment windows, but call them Inventory, Equipment, and KeyItems respectively. The input actions asset used in the demo can be found in the Assets/StylishEsper/Inventool/Examples/[Imported Demo Name] folder.

Step 4: Add Input Support (Cont.)

Add the Default Inventool Input Handler component to the player character. This will allow Inventool's UI to be opened or closed, item drops to be picked up, and merchants to be interacted with.

Step 5: NPC Models

Create 3 NPCs and place them somewhere in the map. In the demo, the player character model was used as NPCs.

Step 6: Merchants

Convert each NPC to a merchant by giving each an Overworld Merchant component and a collider that represents the range in which the player can interact with the merchant. Make the collider a trigger.

Step 7: Merchants (Cont.)

Right-click in the Project section, navigate to Create > Inventool > Merchants, and create one of each. Click on each merchant and set their values from the Inspector. For each Overworld Merchant, reference one of these merchant scriptable objects (ensure they all reference a different one).

Step 8: Merchant Range Indicators

For each overworld merchant component, you can add a GameObject that is used as the indicator for when the player is in range of the merchant.

Step 9: Pick Up Text

Create a script that will enable/disable an object when the player exits/enters the range of an item drop. Create a text object with the text "Pick Up" and add the script to it.

using Esper.Inventool.Items;
using UnityEngine;

namespace Esper.Inventool.Examples
{
    /// <summary>
    /// Example usage of item drop events.
    /// </summary>
    public class PickUpText : MonoBehaviour
    {
        private void Awake()
        {
            ItemDrop.onEnteredPickUpRange.AddListener(() => gameObject.SetActive(true));
            ItemDrop.onExitedPickUpRange.AddListener(() => gameObject.SetActive(false));
        }

        private void Start()
        {
            gameObject.SetActive(false);
        }
    }
}

Step 10: Enter Play Mode!

Everything is ready to go! Simply enter play mode and try it out.