Added README.md
This commit is contained in:
BigPappa committed 2026-08-07 00:56:13 -05:00
1 parent 1981841a32
commit 66c7aef391
1 file changed
+80
+80
View File
@@ -0,0 +1,80 @@
# RS-Warehouse
<p align="center">
![Minecraft](https://img.shields.io/badge/Minecraft-1.21+-brightgreen)
![Platform](https://img.shields.io/badge/Platform-Paper-orange)
![Storage](https://img.shields.io/badge/Storage-SQLite-blue)
![Status](https://img.shields.io/badge/Status-Stable-brightgreen)
![Development](https://img.shields.io/badge/Development-Active-green)
![RS Ecosystem](https://img.shields.io/badge/RS-Ecosystem-purple)
</p>
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