https://github.com/pietras333/inventory-system
A robust, SOLID-principle-based inventory system for Unity games featuring drag-and-drop functionality, item stacking, splitting, and merging capabilities.
https://github.com/pietras333/inventory-system
csharp gamedev inventory-system unity3d
Last synced: 12 months ago
JSON representation
A robust, SOLID-principle-based inventory system for Unity games featuring drag-and-drop functionality, item stacking, splitting, and merging capabilities.
- Host: GitHub
- URL: https://github.com/pietras333/inventory-system
- Owner: pietras333
- Created: 2025-07-05T15:22:28.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-05T15:38:43.000Z (12 months ago)
- Last Synced: 2025-07-05T16:37:38.574Z (12 months ago)
- Topics: csharp, gamedev, inventory-system, unity3d
- Language: C#
- Homepage:
- Size: 35.2 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎮 Unity Inventory System
A robust, SOLID-principle-based inventory system for Unity games featuring drag-and-drop functionality, item stacking, splitting, and merging capabilities.
## ✨ Features
- 🖱️ **Drag & Drop Interface** - Intuitive mouse-based item management
- 📦 **Item Stacking** - Automatic stacking of identical items up to max stack size
- ✂️ **Item Splitting** - Right-click to split item stacks in half
- 🔄 **Item Merging** - Combine compatible items automatically
- 🔁 **Item Swapping** - Swap items between slots seamlessly
- 💡 **Tooltip System** - Hover tooltips with item information
- 🏗️ **SOLID Architecture** - Clean, maintainable, and extensible code structure
- 🔧 **ScriptableObject Configuration** - Easy customization without code changes
- 🌐 **Network Ready** - Built with Unity Netcode integration in mind
## 🛠️ Dependencies
https://github.com/user-attachments/assets/dfa65463-711f-4976-9297-323d5d0a7070
### Unity Version
- **Unity 2022.3 LTS** or higher
### Required Packages
```json
{
"com.unity.textmeshpro": "3.0.6",
"com.unity.netcode.gameobjects": "1.7.1"
}
```
### Installation via Package Manager
1. Open Unity Package Manager (`Window > Package Manager`)
2. Install **TextMeshPro** from Unity Registry
3. Install **Netcode for GameObjects** from Unity Registry
## 📁 Project Structure
```
Assets/
├── 📂 Scripts/
│ ├── 📂 Core/
│ │ ├── 🔧 ItemDefinition.cs
│ │ ├── 🔧 ItemContainerConfig.cs
│ │ └── 🔧 ItemContainerSlotUIConfig.cs
│ ├── 📂 Inventory/
│ │ ├── 📦 ItemContainer.cs
│ │ ├── 🎯 ItemContainerItemUI.cs
│ │ └── 🎪 ItemContainerSlotUI.cs
│ ├── 📂 DragSystem/
│ │ ├── 🎮 ItemDragManager.cs
│ │ ├── 🎯 InventoryInputHandler.cs
│ │ ├── 🔧 ItemDragService.cs
│ │ ├── ⚙️ ItemOperationService.cs
│ │ └── 🎨 DragVisualizer.cs
│ └── 📂 UI/
│ └── 💬 TooltipUI.cs
├── 📂 Prefabs/
│ ├── 📦 InventoryContainer.prefab
│ ├── 🎪 InventorySlot.prefab
│ └── 🎮 ItemDragManager.prefab
└── 📂 ScriptableObjects/
├── 📂 Items/
│ ├── ⚔️ Sword.asset
│ ├── 🛡️ Shield.asset
│ └── 🧪 Potion.asset
└── 📂 Configs/
├── 🔧 DefaultContainerConfig.asset
└── 🎨 DefaultSlotConfig.asset
```
## 🚀 Quick Start
### 1. Setup Item Definitions
```csharp
// Create items via: Assets > Create > Inventory System > Item
// Configure: ID, Name, Description, Icon, Max Stack Size, Prefab
```
### 2. Create Inventory Container
```csharp
// 1. Create empty GameObject
// 2. Add ItemContainer component
// 3. Assign ItemContainerConfig
// 4. Add ItemContainerSlotUI components as children
// 5. Assign slots to the Slots list in ItemContainer
```
### 3. Setup Drag Manager
```csharp
// 1. Create ItemDragManager prefab in scene
// 2. Assign DragVisualizer component
// 3. Configure drag visual elements (Image, Text)
```
### 4. Configure UI Elements
```csharp
// Each slot needs:
// - ItemContainerSlotUI component
// - UI Image for slot background
// - UI Image for held item display
// - TextMeshProUGUI for amount display
```
## 🎯 Usage Examples
### Adding Items to Inventory
```csharp
public class InventoryManager : MonoBehaviour
{
[SerializeField] private ItemContainer playerInventory;
[SerializeField] private ItemDefinition swordItem;
void Start()
{
// Add 5 swords to inventory
playerInventory.TryAddItem(swordItem, 5);
}
}
```
### Custom Item Operations
```csharp
public class CustomItemOperations : MonoBehaviour, IItemOperationService
{
public bool TryMoveItem(ItemContainerItemUI item, ItemContainerSlotUI targetSlot)
{
// Add custom logic (e.g., equipment restrictions)
if (item.ItemDefinition.ItemType == ItemType.Weapon && targetSlot.SlotType != SlotType.WeaponSlot)
return false;
return defaultOperationService.TryMoveItem(item, targetSlot);
}
// Implement other interface methods...
}
```
## 🎨 Customization
### Item Configuration
Create new items through the ScriptableObject menu:
- **Right-click in Project** → **Create** → **Inventory System** → **Item**
### Visual Customization
- **Slot Icons**: Configure active/passive slot sprites in `ItemContainerSlotUIConfig`
- **Drag Visuals**: Customize drag appearance in `DragVisualizer` component
- **Tooltips**: Modify `TooltipUI` for custom tooltip styles
### Extending Functionality
```csharp
// Add new item operations
public class EnchantmentService : IItemOperationService
{
public bool TryEnchantItem(ItemContainerItemUI item, EnchantmentType enchantment)
{
// Custom enchantment logic
return true;
}
}
```
## 🏗️ Architecture Overview
### SOLID Principles Implementation
- **🔧 Single Responsibility**: Each class has one clear purpose
- **📖 Open/Closed**: Easy to extend without modifying existing code
- **🔄 Liskov Substitution**: Interfaces can be swapped seamlessly
- **🎯 Interface Segregation**: Focused, specific interfaces
- **🔗 Dependency Inversion**: Depends on abstractions, not concrete classes
### Key Components
| Component | Responsibility |
|-----------|---------------|
| `ItemDragService` | 🎯 Manages drag state |
| `ItemOperationService` | ⚙️ Handles item operations |
| `DragVisualizer` | 🎨 Visual drag representation |
| `InventoryInputHandler` | 🎮 Input processing |
| `ItemDragManager` | 🎪 Facade coordinator |
## 🧪 Testing
### Unit Testing Setup
```csharp
[Test]
public void TestItemMerging()
{
// Arrange
var mockDragService = new Mock();
var operationService = new ItemOperationService();
// Act & Assert
Assert.IsTrue(operationService.TryMergeItems(item1, slot));
}
```
## 🤝 Contributing
1. 🍴 Fork the repository
2. 🌟 Create a feature branch (`git checkout -b feature/amazing-feature`)
3. 💾 Commit changes (`git commit -m 'Add amazing feature'`)
4. 📤 Push to branch (`git push origin feature/amazing-feature`)
5. 🔄 Open a Pull Request
## 📋 Requirements
- ✅ Unity 2022.3 LTS+
- ✅ TextMeshPro
- ✅ Unity Netcode for GameObjects (optional)
- ✅ C# 9.0+ support
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- 🎮 Unity Technologies for the excellent game engine
- 👥 Game development community for inspiration and best practices
- 📚 Clean Code principles by Robert C. Martin
## 📞 Support
- 🐛 **Bug Reports**: Open an issue with detailed reproduction steps
- 💡 **Feature Requests**: Open an issue with [FEATURE REQUEST] prefix
- 💬 **Questions**: Use GitHub Discussions for general questions
---
⭐ **Star this repository if you find it helpful!** ⭐
Made with ❤️ for the Unity community