Rinkaa / Kangaskhan

🕹Inventory mechanism class library defined for game programming, written in C# without any dependency on any game engine.

Kangaskhan || 袋兽

Kangaskhan: Hello, there! Welcome to Kangaskhan Storage.
袋兽：甜心，欢迎来到袋兽仓库！

▶Store 存放  Take   取出
 Info  说明  Cancel 取消

🕹Inventory mechanism class library defined for game programming, written in C# without any dependency on any game engine. Based on .Net standard 2.0. Under MIT License.

无引擎依赖，用C#语言编写的用于游戏程序的道具系统。基于.Net standard 2.0，使用MIT协议。

Contents || 内容

The current version is v0.1

当前版本为v0.1

Description || 说明

• Inventory item definition, class attribute- and instance component- wise
• 道具定义，可定制类特性与实例组件
• Item stacking
• 道具堆叠
• Inventory storage definition, list-like and cell-like
• 道具仓库定义，包括列表仓库与格子仓库

Structure || 结构

• InventoryItem
• InventoryItemFactor
• InventoryItemType
• InventoryItemTypeFactor
• Features
  • Stacking
    • StackableTypeFactor
    • InventoryItemStack
• Applications
  • Storages
    • InventoryStorageEntry
    • InventoryStorage{TEntry}
    • ItemStorageEntry
    • StackStorageEntry
    • ItemListStorage
    • ItemCellStorage
    • AutoPurging
      • ValidatableEntry{TInnerEntry}
      • AutoPurgingStorage{TInnerStorage}
      • EmptyCheckedStackStorageEntry
      • StackListStorage
      • StackCellStorage

TODOs || 待完成

• Unit tests
• Sample console app
• Simple usage guide in readme.md
• Feature: Expiring (a InventoryItem factor, meaning that each instance having this factor has an expire time.
• Feature: HasFactor (a InventoryItemType factor, meaning that all instances of this kind have a certain factor.)
• Feature: HasAction (a InventoryItemType factor, meaning that all instances of this kind have a certain action to operate.)

Open for feature suggestions and pull requests! || 欢迎提出功能建议或提出推送请求！

This project is at its initial stage with a minimal set of features. We would be very grateful if you could help us with ideas about what an Inventory mechanism library should include!

Feel free to leave your suggestions at the Issue page and mark them as "feature-suggestion". <3

项目仍在初期，功能比较简朴，如能助力此项目成长，我们不胜感激！

您可以在Issue页留下您的建议并将其注为"feature-suggestion"。比心

Changelog || 更改记录

• v0.1
  • Repo init.
  • 项目初始。