diff --git a/README.md b/README.md new file mode 100644 index 0000000..17a7dc2 --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +# RS-Warehouse + +
+ + + + + + + + +
+ +A high-performance Paper plugin that replaces traditional chest storage with a centralized warehouse system. + +Instead of managing hundreds of chests scattered throughout your server, players deposit items into a shared warehouse where they can be organized using categories and subcategories. + +Designed with performance, simplicity, and scalability in mind, RS-Warehouse is suitable for both small community servers and large survival worlds. + +--- + +## Features + +- 📦 Centralized warehouse inventory +- 📂 Categories and subcategories +- 📥 One-click item deposits +- 📤 Simple item withdrawals +- 🆕 Automatic discovery of new materials +- 🛠️ Full in-game administration +- 💾 SQLite database +- 🚀 Optimized for Paper servers + +--- + +## Requirements + +- Paper 1.21+ +- Java 21+ + +--- + +## Installation + +1. Download the latest release. +2. Copy `RS-Warehouse.jar` into your server's `plugins` folder. +3. Start or restart your server. +4. Configure the plugin if desired. + +For complete installation instructions and screenshots, see the **Wiki**. + +--- + +## Documentation + +Complete documentation is available in the Wiki. + +- Installation & Setup +- Creating Your First Warehouse +- Categories +- Subcategories +- Depositing Items +- Withdrawing Items +- Permissions +- Commands +- Configuration +- FAQ + +--- + +## Issues & Feature Requests + +Found a bug or have an idea for a new feature? + +Please use the **Issues** section of this repository. + +--- + +## License + +MIT License \ No newline at end of file