Moving wiki to project structure for easier editing.
This commit is contained in:
BigPappa committed 2026-08-07 01:24:07 -05:00
1 parent ea4e07d07f
commit 44a4df63db
2 files changed
+163 -91

No files matched your search

+47 -89
View File
@@ -1,118 +1,76 @@
# RS-Warehouse
### Centralized Warehouse Management for Modern Minecraft Servers
<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>
RS-Warehouse replaces traditional chest storage with a centralized warehouse system that stores every item in a searchable database. Instead of managing dozens of overflowing storage rooms, players deposit items into a Warehouse Chest and organize them using categories and subcategories.
# 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.
Designed with performance, simplicity, and scalability in mind, RS-Warehouse is suitable for both small community servers and large survival worlds.
---
## Features
- 📦 Shared warehouse inventory
- 📦 Centralized warehouse inventory
- 📂 Categories and subcategories
- 📥 One-click item deposits
- 📤 Simple item withdrawals
- 🆕 Automatic discovery of new materials
- 🛠️ Full in-game administration
- 📥 Deposit items into a shared warehouse
- 📤 Withdraw items through an intuitive GUI
- 🏷 Automatic discovery of new materials
- ⚙ Complete in-game administration
- 💾 SQLite database
- 🚀 Optimized for Paper servers
- 🚀 Designed for high-performance Paper servers
---
## Requirements
## Why Use RS-Warehouse?
- Paper 1.21+
- Java 21+
Traditional storage rooms become increasingly difficult to manage as a server grows. Players spend time searching through walls of chests, organizing storage rooms, and moving items between containers.
RS-Warehouse replaces those storage rooms with a centralized warehouse. Players simply deposit items into a Warehouse Chest, and the warehouse keeps track of everything in a shared database. Administrators organize the warehouse using categories and subcategories, giving every player access to a clean, organized storage system. No more walls of storage chests!
---
## Installation
## Quick Start
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`
1. Install the plugin.
2. Create a Warehouse Chest.
3. Create your first categories.
4. Deposit your first items.
5. Enjoy organized storage.
Continue to the **Installation & Setup** guide to get started.
---
## Documentation
Complete documentation is available in the **docs** folder.
- [Installation & Setup](Installation-&-Setup)
- Creating a Warehouse
- Depositing Items
- Withdrawing Items
- Categories
- Subcategories
- Permissions
- Commands
- Configuration
- FAQ
### Getting Started
# Documentation
- [Home](docs/README.md)
- [Installation & Setup](docs/Installation-&-Setup.md)
- [Creating a Warehouse Chest](docs/Creating-a-Warehouse-Chest.md)
Getting Started
- [x] Home
- [x] Installation & Setup
- [ ] Creating Your First Warehouse
### Using the Warehouse
Using the Warehouse
- [ ] Depositing Items
- [ ] Withdrawing Items
- [ ] Categories
- [ ] Subcategories
- [Depositing Items](docs/Depositing-Items.md)
- [Withdrawing Items](docs/Withdrawing-Items.md)
Administration
- [ ] Permissions
- [ ] Commands
- [ ] Configuration
### Organization
- [Categories](docs/Categories.md)
- [Subcategories](docs/Subcategories.md)
### Administration
- [Permissions](docs/Permissions.md)
- [Commands](docs/Commands.md)
- [Configuration](docs/Configuration.md)
### Reference
- [FAQ](docs/FAQ.md)
---
## Issues & Feature Requests
Found a bug?
Have an idea for a new feature?
Please use the **Issues** section of this repository.
---
## Roadmap
Future features currently planned include:
- 🔍 Warehouse Search
- Additional quality-of-life improvements
- Continued performance optimizations
See the **Issues** page for the complete roadmap and planned enhancements.
---
## License
MIT License
Copyright (c) Raymond Russelburg
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Reference
- [ ] FAQ