Skip to content

Installation & Setup โ€‹

Requirements โ€‹

Before importing Tidy Up! โ€” Sorting & Shelving Simulator Toolkit, verify that your project meets the following requirements:

  • Unity Editor: Unity 6 (6000.0+) or Unity 2022.3 LTS+.
  • Render Pipeline: Universal Render Pipeline (URP).
  • Input Package: Unity New Input System (com.unity.inputsystem).
  • Text Package: TextMeshPro / uGUI.
  • Target Platforms: PC (Windows / Mac / Linux), Steam Deck, Consoles, Mobile, WebGL.
  1. Acquire the toolkit from the Unity Asset Store.
  2. Open your Unity project.
  3. Navigate to Window โ†’ Package Manager.
  4. In the Package Manager top-left dropdown, select Packages: My Assets.
  5. Search for Tidy Up! โ€” Sorting & Shelving Simulator Toolkit.
  6. Click Download, then click Import.
  7. Keep all files checked and click Import.

Method 2: Custom Package File (.unitypackage) โ€‹

  1. In Unity, go to Assets โ†’ Import Package โ†’ Custom Package...
  2. Select your exported .unitypackage file.
  3. Click Import.

Package Directory Layout โ€‹

All assets reside in an organized directory structure:

Assets/SortAndShelveToolkit/
โ”œโ”€โ”€ Art/
โ”‚   โ”œโ”€โ”€ Materials/          # Stylized URP surface materials
โ”‚   โ”œโ”€โ”€ Models/             # 3D meshes for props, shelving, furniture
โ”‚   โ”œโ”€โ”€ Textures/           # Diffuse and normal maps
โ”‚   โ””โ”€โ”€ UI/                 # 9-slice sprites, icons, and frames
โ”œโ”€โ”€ Audio/                  # SFX clips (pickup, snap, coin, victory)
โ”œโ”€โ”€ Documentation/          # README and QuickStart guides
โ”œโ”€โ”€ Editor/
โ”‚   โ”œโ”€โ”€ Utilities/          # Audio synthesizer and scene builders
โ”‚   โ””โ”€โ”€ Windows/            # Dashboard, Wizard, Auditor, Importer, Theme Switcher
โ”œโ”€โ”€ Prefabs/
โ”‚   โ”œโ”€โ”€ Items/              # Physical item prefabs with colliders and rigidbodies
โ”‚   โ””โ”€โ”€ UI/                 # HUD, Shop, Level Select, and Modal prefabs
โ”œโ”€โ”€ Runtime/
โ”‚   โ”œโ”€โ”€ Audio/              # AudioManager and SoundTrigger
โ”‚   โ”œโ”€โ”€ Core/               # Singleton, Pooling, and Event types
โ”‚   โ”œโ”€โ”€ Data/               # ScriptableObject definitions (Item, Category, Upgrade)
โ”‚   โ”œโ”€โ”€ Environment/        # Ambient lights and decorative props
โ”‚   โ”œโ”€โ”€ Items/              # ItemInstance, DeliveryBox, PileGenerator
โ”‚   โ”œโ”€โ”€ Player/             # FirstPersonController, CarrySystem, InteractionController
โ”‚   โ”œโ”€โ”€ Progression/        # CompletionTracker, CurrencyManager, UpgradeManager
โ”‚   โ”œโ”€โ”€ SaveSystem/         # SaveManager and SaveData models
โ”‚   โ”œโ”€โ”€ Shelving/           # ShelfZone, ShelfSlot, ProceduralShelf
โ”‚   โ””โ”€โ”€ UI/                 # HUDView, ShopMenuView, SettingsMenuView, MainMenuController
โ”œโ”€โ”€ Scenes/                 # MainMenuScene, ApothecaryDemoScene, WorkshopDemoScene
โ””โ”€โ”€ ScriptableObjects/      # Categories, Items, and Upgrades

Assembly Definitions โ€‹

The package utilizes two isolated assembly definitions:

  • SortAndShelveToolkit.Runtime.asmdef: Contains all gameplay, player, physics, shelving, UI, and progression scripts.
  • SortAndShelveToolkit.Editor.asmdef: Contains all editor windows, auditors, setup wizards, and scene builders.

This guarantees modularity and prevents namespace conflicts with your game code.

The Editor Suite โ€‹

Access all tools from the Unity menu under:

Tools > Nipun Interactive > Tidy Up! - Sorting & Shelving Simulator Toolkit
  • โ˜… Toolkit Dashboard & Hub: Unified command center with quick start tabs, demo scene openers, and documentation links.
  • Scene Setup Wizard: 1-click level bootstrap configuring the 5-header hierarchy, player prefab, managers, and HUD.
  • Level Health & Auditor: Diagnostic window checking category quotas, shelf capacities, physics colliders, and offering 1-click auto-fixes.
  • Bulk Item Importer: Spreadsheets-to-ScriptableObjects generator for rapid item authoring.
  • Theme Preset Switcher: 1-click visual reskinning tool.

Built for Unity Game Developers worldwide.