From 7c3137fa4445014abb7da3aeefd2b4425fb86e60 Mon Sep 17 00:00:00 2001 From: Big Pappa Date: Fri, 7 Aug 2026 01:33:25 -0500 Subject: [PATCH] 1.0.0 Moving wiki to project structure for easier editing. --- docs/Home.md | 82 ++++++++++++++++++++++------------------------------ 1 file changed, 34 insertions(+), 48 deletions(-) diff --git a/docs/Home.md b/docs/Home.md index 7de96a2..be853ba 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -1,76 +1,62 @@ -### Centralized Warehouse Management for Modern Minecraft Servers +# RS-Warehouse +

+![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) -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. +# 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 -- 📦 Centralized warehouse inventory +- 📦 Shared 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 +- 📥 One-click item deposits +- 📤 Simple item withdrawals +- 🆕 Automatic discovery of new materials +- 🛠️ Full in-game administration - 💾 SQLite database -- 🚀 Designed for high-performance Paper servers +- 🚀 Optimized for Paper servers --- -## Why Use RS-Warehouse? +## Requirements -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! +- Paper 1.21+ +- Java 21+ --- -## Quick Start +## Issues & Feature Requests -1. Install the plugin. -2. Create a Warehouse Chest. -3. Create your first categories. -4. Deposit your first items. -5. Enjoy organized storage. +Found a bug? -Continue to the **Installation & Setup** guide to get started. +Have an idea for a new feature? + +Please use the **Issues** section of this repository. --- -## Documentation +## License -- [Installation & Setup](Installation-&-Setup) -- Creating a Warehouse -- Depositing Items -- Withdrawing Items -- Categories -- Subcategories -- Permissions -- Commands -- Configuration -- FAQ +MIT License -# Documentation +Copyright (c) Raymond Russelburg -Getting Started -- [x] Home -- [x] Installation & Setup -- [ ] Creating Your First Warehouse +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: -Using the Warehouse -- [ ] Depositing Items -- [ ] Withdrawing Items -- [ ] Categories -- [ ] Subcategories +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -Administration -- [ ] Permissions -- [ ] Commands -- [ ] Configuration - -Reference -- [ ] FAQ \ No newline at end of file +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. \ No newline at end of file