1.0.0
Moving wiki to project structure for easier editing.
This commit is contained in:
BigPappa committed
1 parent
164898c4ea
commit
d2c60f29dd
5 files changed
+8
-8
No files matched your search
@@ -0,0 +1,118 @@
|
||||
# RS-Warehouse
|
||||
|
||||
<p align="center">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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](docs/Home.md)
|
||||
- [Installation & Setup](docs/Installation-&-Setup.md)
|
||||
- [Creating a Warehouse Chest](docs/Creating-a-Warehouse-Chest.md)
|
||||
|
||||
### Using the Warehouse
|
||||
|
||||
- [Depositing Items](docs/Depositing-Items.md)
|
||||
- [Withdrawing Items](docs/Withdrawing-Items.md)
|
||||
|
||||
### 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.
|
||||
@@ -0,0 +1,74 @@
|
||||
Welcome to the # Installation & Setup
|
||||
|
||||
This guide will walk you through installing RS-Warehouse and preparing it for first use.
|
||||
|
||||
---
|
||||
|
||||
# Requirements
|
||||
|
||||
Before installing RS-Warehouse, ensure your server meets the following requirements.
|
||||
|
||||
- Paper 1.21.x or newer
|
||||
- Java 21 or newer
|
||||
|
||||
---
|
||||
|
||||
# Step 1 - Download RS-Warehouse
|
||||
|
||||
Download the latest release of RS-Warehouse.
|
||||
|
||||
---
|
||||
|
||||
# Step 2 - Install the Plugin
|
||||
|
||||
Copy **RS-Warehouse.jar** into your server's **plugins** folder.
|
||||
|
||||
```
|
||||
plugins/
|
||||
└── RS-Warehouse.jar
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
|
||||
|
||||
# Step 3 - Start Your Server
|
||||
|
||||
Start your Paper server.
|
||||
|
||||
During startup RS-Warehouse will automatically create its data folder, configuration file, and SQLite database.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
# Step 4 - Verify Installation
|
||||
|
||||
After the server has started, verify that the plugin created its data folder.
|
||||
|
||||
Your plugins folder should now contain:
|
||||
|
||||
```
|
||||
plugins/
|
||||
└── RS-Warehouse/
|
||||
├── config.yml
|
||||
└── database.db
|
||||
```
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
# What's Next?
|
||||
|
||||
RS-Warehouse is now installed.
|
||||
|
||||
The next step is creating your first Warehouse Chest and preparing the warehouse for use.
|
||||
|
||||
➡ Continue to **Creating Your First Warehouse**Wiki.
|
||||
@@ -0,0 +1,74 @@
|
||||
# Creating a Warehouse Chest
|
||||
|
||||
This guide walks you through creating your first Warehouse Chest.
|
||||
|
||||
---
|
||||
|
||||
## Before You Begin
|
||||
|
||||
Ensure:
|
||||
|
||||
- RS-Warehouse is installed.
|
||||
- You have administrative permissions.
|
||||
- The server has been started at least once.
|
||||
|
||||
If not, complete the
|
||||
[Installation & Setup](2.%20Installation-&-Setup.md)
|
||||
guide first.
|
||||
|
||||
---
|
||||
|
||||
## Step 1 - Place a Chest
|
||||
|
||||
Place a normal chest anywhere in the world.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Step 2 - Open the Chest
|
||||
|
||||
Open the chest.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Step 3 - Convert the Chest
|
||||
|
||||
Use the Warehouse administration menu to convert the chest into a Warehouse Chest.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Step 4 - Verify the Chest
|
||||
|
||||
Verify the chest has successfully become a Warehouse Chest.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Step 5 - Open the Warehouse
|
||||
|
||||
Open the Warehouse Chest.
|
||||
|
||||
The warehouse browser should appear.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Finished
|
||||
|
||||
Your warehouse is now ready for organization.
|
||||
|
||||
Continue with
|
||||
[Categories](../Categories.md).
|
||||
|
||||
---
|
||||
|
||||
⬅️ Previous: [Installation & Setup](2.%20Installation-&-Setup.md)
|
||||
|
||||
➡️ Next: [Categories](../Categories.md)
|
||||
Reference in new issue
Block a user