Documentation Update
This commit is contained in:
BigPappa committed 2026-08-07 22:13:59 -05:00
1 parent 831f629427
commit 0f5cd2391c
1 file changed
+85
View File
@@ -0,0 +1,85 @@
# 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>
# Centralized Warehouse Management for Modern Minecraft Servers
RS-Warehouse is a high-performance Paper plugin that replaces traditional chest storage with a centralized warehouse system.
Instead of managing hundreds of overflowing chests, players deposit items into a shared warehouse where everything is organized using categories and subcategories. The result is a cleaner, faster, and more scalable storage solution for servers of any size.
---
## Features
- 📦 Shared 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 from the **Releases** page.
2. Copy `RS-Warehouse.jar` into your server's `plugins` folder.
3. Start or restart your Paper server.
4. RS-Warehouse will automatically create:
- `plugins/RS-Warehouse/`
- `config.yml`
- `database.db`
---
## Documentation
Complete documentation is available in the **docs** folder.
### Getting Started
- [Home](/truenas_admin/RS-Warehouse/src/branch/main/docs/01%20Getting%20Started/A%20Home.md)
- [Installation And Setup](/truenas_admin/RS-Warehouse/src/branch/main/docs/01%20Getting%20Started/B%20Installation%20And%20Setup.md)
- [Creating a Warehouse Chest](/truenas_admin/RS-Warehouse/src/branch/main/docs/01%20Getting%20Started/C%20Creating%20A%20Warehouse%20Chest.md)
### Using the Warehouse
- [Depositing Items]
- [Withdrawing Items]
### Organization
- [Categories]
- [Subcategories]
### Administration
- [Permissions]
- [Commands]
- [Configuration]
### Reference
- [FAQ]
---