Quick Start Guide

Build a fully playable sorting and shelving level from scratch in under 10 minutes.

Step 1: Bootstrapping a New Level (1-Click Setup)

1. In Unity, create a new scene (File > New Scene > Basic (URP)).
2. Save your scene (e.g. Assets/MyGame/Scenes/Level_01.unity).
3. Open Tools > Nipun Interactive > Tidy Up! - Sorting & Shelving Simulator Toolkit > Scene Setup Wizard.
4. Click ★ Setup Entire Scene (All in One).

This instantly scaffolds the standard 5-header hierarchy:

• --- ENVIRONMENT ---: Room bounds and basic surfaces.
• --- LIGHTING ---: Configured directional sunlight and ambient lighting.
• --- GAMEPLAY ---: Player rig (FirstPersonController, CarrySystem, InteractionController).
• --- MANAGERS ---: Progression managers (CompletionTracker, CurrencyManager, UpgradeManager, SaveManager, AudioManager, ItemPoolManager).
• --- UI ---: Responsive HUD Canvas (HUDView, ShopMenuView, SettingsMenuView, CompletionScreenView).

Step 2: Creating Categories & Items

Creating a Category

1. In the Project window, right-click and select: Create > Tidy Up! - Sorting & Shelving > Category Definition
2. Name the asset (e.g. Category_Potions).
3. In the Inspector, configure:
   • ID: cat_potions
   • Display Name: Healing Potions
   • Theme Color: Green or Cyan
   • Icon: Optional Sprite icon

Creating Items

1. Right-click and choose: Create > Tidy Up! - Sorting & Shelving > Item Definition
2. Assign the Category created above.
3. Assign the visual 3D Prefab (must contain a Collider and MeshRenderer).
4. Set currency rewards and hold scale offsets.

Bulk Item Authoring

To create dozens of items quickly, open Tools > Nipun Interactive > Tidy Up! - Sorting & Shelving Simulator Toolkit > Bulk Item Importer, paste comma-separated definitions, and click Generate Item ScriptableObjects.

Step 3: Setting Up Shelves with Snap Slots

1. Place your shelf 3D mesh in your scene under --- GAMEPLAY ---.
2. Add a ShelfZone component to the shelf object.
3. In the ShelfZone Inspector:
   • Set Target Category to your category definition.
   • Set Display Name (e.g. Potion Cabinet).
4. Add a ProceduralShelf component to the shelf.
5. Set Rows (e.g. 3) and Columns (e.g. 4), then click Generate Slots.
   • 12 uniform ShelfSlot instances will be automatically instantiated and aligned.

Step 4: Configuring the Item Spawner

1. In the scene hierarchy under --- GAMEPLAY ---, create an empty GameObject named Item_Spawner.
2. Add a PileGenerator component.
3. In the Items To Spawn list, add your ItemDefinition assets and specify the desired count (e.g. 12 potions).
4. Configure the spawn zone extents, scatter impulse, and check Spawn In Batches for smooth frame-budgeted spawning.

Step 5: Validating Scene Balance Before Shipping

1. Open Tools > Nipun Interactive > Tidy Up! - Sorting & Shelving Simulator Toolkit > Level Health & Auditor.
2. Click 🔄 Scan Active Scene.
3. The validator checks:
   • Item quotas vs shelf capacities (guaranteeing 100% level solvability).
   • Rigidbody, collider, and PhysicsSleeper presence on all item prefabs.
   • Manager linkages.
4. If any issues are flagged, click ✨ Auto-Fix All Issues to repair them automatically.

Step 6: Testing in Play Mode

Press Play in Unity:

• W, A, S, D: Walk / Strafe
• Left Shift: Sprint
• Space: Jump
• Mouse Look: Aim reticle
• E: Grab item / Place on shelf slot
• Mouse Scroll Wheel: Adjust carried item distance
• Right Click / Q: Throw / Drop held item
• Tab: Open Upgrade Shop
• Escape: Pause / Settings Menu

Pick up an item, bring it near the matching shelf, and press [E] to snap-place. Watch currency flyaway numbers appear as progress advances toward the Par Time rating!