1.0.0
Moving wiki to project structure for easier editing.
This commit is contained in:
BigPappa committed
1 parent
66c7aef391
commit
7c466d3642
2 files changed
+78
-78
No files matched your search
@@ -1,80 +1,4 @@
|
|||||||
# RS-Warehouse
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</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
|
## Documentation
|
||||||
|
|
||||||
Complete documentation is available in the Wiki.
|
- [Home](docs/Home.md)
|
||||||
|
- [Installation & Setup](docs/Installation-&-Setup.md)
|
||||||
- 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
|
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
Welcome to the Wiki.# RS-Warehouse
|
||||||
|
|
||||||
|
### Centralized Warehouse Management for Modern Minecraft Servers
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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
|
||||||
|
- 📥 Deposit items into a shared warehouse
|
||||||
|
- 📤 Withdraw items through an intuitive GUI
|
||||||
|
- 🏷 Automatic discovery of new materials
|
||||||
|
- ⚙ Complete in-game administration
|
||||||
|
- 💾 SQLite database
|
||||||
|
- 🚀 Designed for high-performance Paper servers
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Why Use RS-Warehouse?
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
- [Installation & Setup](Installation-&-Setup)
|
||||||
|
- Creating a Warehouse
|
||||||
|
- Depositing Items
|
||||||
|
- Withdrawing Items
|
||||||
|
- Categories
|
||||||
|
- Subcategories
|
||||||
|
- Permissions
|
||||||
|
- Commands
|
||||||
|
- Configuration
|
||||||
|
- FAQ
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
|
||||||
|
Getting Started
|
||||||
|
- [x] Home
|
||||||
|
- [x] Installation & Setup
|
||||||
|
- [ ] Creating Your First Warehouse
|
||||||
|
|
||||||
|
Using the Warehouse
|
||||||
|
- [ ] Depositing Items
|
||||||
|
- [ ] Withdrawing Items
|
||||||
|
- [ ] Categories
|
||||||
|
- [ ] Subcategories
|
||||||
|
|
||||||
|
Administration
|
||||||
|
- [ ] Permissions
|
||||||
|
- [ ] Commands
|
||||||
|
- [ ] Configuration
|
||||||
|
|
||||||
|
Reference
|
||||||
|
- [ ] FAQ
|
||||||
Reference in new issue
Block a user