Player Inventory System

Player Inventory System >> 0.0.5 Alpha!

The Player Inventory System is designed to make implementing an inventory system in your game simple. I developed this system to replicate yet improve upon the functionality of the inventory system in an existing and very popular game.The Player Inventory System will allow you to add this functionality to you game with ease.

Features

• Item Bar to store items for quick access,
• Inventory Panel to allow player to carry more objects while they move around,
• Chests to allow leaving items long term,
• Character Panel allows equipping gear and weapons and displays player stats,
• Crafting Panel allows player to create new items from others,
• Item info Panel allows player to view information about items in his/her inventory,
• Drag and drop items between inventories and slots,
• Place-able items,
• Consumable items,
• Stackable items,
• Items can be used to impart buffs on player,
• Item durability,
• Item Catalog for easy configuration and mapping of items and their properties.
• Custom editor scripts help organize items in your catalog.
• Simple design allows you to easily swap catalogs and themes at runtime.
• Encrypted object serialization and saving to help prevent cheating,
• Inventory/chest contents, placed and dropped items can be loaded and saved automatically,
• Includes Debug/Advanced Inventory Panel to help you develop your game quicker.

Requirements

1. Unity 2022.3 or higher

2. Unity Input system Package 1.6.3 or higher

Git Repo

Cloned the git repository you can open the project through Unity Hub.

Starting From Scratch

Assuming you already have a Unity project open that contains either the contents of the Unity package or the repository, follow these steps to add the Player Inventory System to a new scene.

1. Drag the prefab PlayerInventorySystem\Prefabs\InventorySystem into your scene. 
2. Add an event system object by right clicking the hierarchy and selecting UI->Event System
3.  Add your player object to your scene.
4.  Add a PlayerInventoryControler component to your player object.
5. Select the InventorySystem in the hierarchy and drag your player object in to the player property slot.

NOTE: While the demo in the package includes scripts to control the player, anything located in the Demo folder is not supported under this system. The scripts are used to provide simple gameplay so the demo can do its thing. They should NOT be considered part of the Player Inventory System and as such are not covered in the documentation except were to explain how to integrate with existing player controllers and the input system.

How it works

The Inventory controller is the hub of the system. It has methods to create and interact with inventories. It contains a number of lists of inventories relating to the player, chests and placed or spawned items and the methods to interact with them. 

Please read the code docs to find out about all the methods available and how to use them.

Documentation

As this system is still in alpha you can find most of the documentation in the code.

To get started open the file PlayerInventorySystem\Scripts\Controller\InventoryController.cs and read the comments at the start of the file.

Full documentation will be added once the player inventory system has moved to beta.

Assets

All assets are free to use as you wish so long as you give credit where its due.

Demo Scene

The repo contains a simple demo scene that allows you to test each of the systems functions. Depending on the state of the project at the last push to the git repo, the demo scene may or may not work correctly.

As the project progresses the demo scene will be expanded and features fixed in place.