1.0.0
Documentation Update
This commit is contained in:
BigPappa committed
1 parent
61749397df
commit
70c4193b46
5 files changed
+4
-4
No files matched your search
@@ -0,0 +1,84 @@
|
||||
# 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
|
||||
[TEST](01 Getting Started/test.md)
|
||||
[Home](A Home.md)
|
||||
[TESTB](B Installation And Setup.md)
|
||||
[Installation & Setup](B%29%20Installation%20And%20Setup.md)
|
||||
|
||||
### Using the Warehouse
|
||||
|
||||
- [Depositing Items]
|
||||
- [Withdrawing Items]
|
||||
|
||||
### Organization
|
||||
|
||||
- [Categories]
|
||||
- [Subcategories]
|
||||
|
||||
### Administration
|
||||
|
||||
- [Permissions]
|
||||
- [Commands]
|
||||
- [Configuration]
|
||||
|
||||
### Reference
|
||||
|
||||
- [FAQ]
|
||||
|
||||
---
|
||||
@@ -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)
|
||||
@@ -0,0 +1 @@
|
||||
;lkj;lkj;l
|
||||
Reference in new issue
Block a user