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+)orUnity 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.
Method 1: Unity Asset Store (Recommended) โ
- Acquire the toolkit from the Unity Asset Store.
- Open your Unity project.
- Navigate to Window โ Package Manager.
- In the Package Manager top-left dropdown, select Packages: My Assets.
- Search for Tidy Up! โ Sorting & Shelving Simulator Toolkit.
- Click Download, then click Import.
- Keep all files checked and click Import.
Method 2: Custom Package File (.unitypackage) โ
- In Unity, go to Assets โ Import Package โ Custom Package...
- Select your exported
.unitypackagefile. - 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 UpgradesAssembly 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.