1.0.0
Documentation Update
This commit is contained in:
1 parent
f191302ffb
commit
d7ed9b0fe3
13 files changed
+81
-26
No files matched your search
Whitespace-only changes.
@@ -0,0 +1,82 @@
|
||||
# Categories
|
||||
|
||||
Categories organize every item stored inside the warehouse.
|
||||
|
||||
Well-designed categories make browsing quick and intuitive.
|
||||
|
||||
---
|
||||
|
||||
## Opening Category Management
|
||||
|
||||
Open the Warehouse.
|
||||
|
||||
Open the Administration menu.
|
||||
|
||||
Select Categories.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Creating a Category
|
||||
|
||||
Choose **Create Category**.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Internal Name
|
||||
|
||||
Enter a unique internal name.
|
||||
|
||||
Example:
|
||||
|
||||
building_blocks
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Display Name
|
||||
|
||||
Enter the player-visible name.
|
||||
|
||||
Examples:
|
||||
|
||||
- Building Blocks
|
||||
- Food
|
||||
- Farming
|
||||
- Combat
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Icon
|
||||
|
||||
Select an icon that represents the category.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Enter an optional description.
|
||||
|
||||
This is displayed in the category lore.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Finished
|
||||
|
||||
Repeat these steps until your warehouse is organized.
|
||||
|
||||
---
|
||||
|
||||
⬅️ Previous: [Creating a Warehouse Chest](01%20Getting%20Started/C)%20Creating%20A%20Warehouse%20Chest.md)
|
||||
|
||||
➡️ Next: [Subcategories](Subcategories.md)
|
||||
@@ -0,0 +1,11 @@
|
||||
# Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| *(To be completed)* | |
|
||||
|
||||
---
|
||||
|
||||
⬅️ Previous: [Permissions](Permissions.md)
|
||||
|
||||
➡️ Next: [Configuration](Configuration.md)
|
||||
@@ -0,0 +1,13 @@
|
||||
# Configuration
|
||||
|
||||
Every configuration option is documented below.
|
||||
|
||||
| Setting | Description | Default |
|
||||
|----------|-------------|---------|
|
||||
| *(To be completed)* | | |
|
||||
|
||||
---
|
||||
|
||||
⬅️ Previous: [Commands](Commands.md)
|
||||
|
||||
➡️ Next: [FAQ](01)%20Getting%20Started/FAQ.md)
|
||||
@@ -0,0 +1,47 @@
|
||||
# Depositing Items
|
||||
|
||||
Players can deposit items directly into the warehouse.
|
||||
|
||||
---
|
||||
|
||||
## Open the Warehouse
|
||||
|
||||
Open the Warehouse Chest.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Select Deposit
|
||||
|
||||
Choose Deposit.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Select Items
|
||||
|
||||
Choose the items to deposit.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Confirmation
|
||||
|
||||
Items are transferred into warehouse storage.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Finished
|
||||
|
||||
Your items are now available to all authorized players.
|
||||
|
||||
---
|
||||
|
||||
⬅️ Previous: [Subcategories](Subcategories.md)
|
||||
|
||||
➡️ Next: [Withdrawing Items](Withdrawing-Items.md)
|
||||
Whitespace-only changes.
@@ -0,0 +1,37 @@
|
||||
# Frequently Asked Questions
|
||||
|
||||
## Why is my warehouse empty?
|
||||
|
||||
Items have not yet been deposited.
|
||||
|
||||
---
|
||||
|
||||
## Can multiple players use the same warehouse?
|
||||
|
||||
Yes.
|
||||
|
||||
---
|
||||
|
||||
## Does RS-Warehouse support SQLite?
|
||||
|
||||
Yes.
|
||||
|
||||
SQLite is used by default.
|
||||
|
||||
---
|
||||
|
||||
## Can I organize items?
|
||||
|
||||
Yes.
|
||||
|
||||
Categories and subcategories provide flexible organization.
|
||||
|
||||
---
|
||||
|
||||
## Where can I request features?
|
||||
|
||||
Please use the repository's **Issues** page.
|
||||
|
||||
---
|
||||
|
||||
⬅️ Previous: [Configuration](Configuration.md)
|
||||
Whitespace-only changes.
@@ -0,0 +1,13 @@
|
||||
# Permissions
|
||||
|
||||
This page documents every permission node used by RS-Warehouse.
|
||||
|
||||
| Permission | Description | Default |
|
||||
|------------|-------------|---------|
|
||||
| *(To be completed)* | | |
|
||||
|
||||
---
|
||||
|
||||
⬅️ Previous: [Withdrawing Items](Withdrawing-Items.md)
|
||||
|
||||
➡️ Next: [Commands](Commands.md)
|
||||
@@ -0,0 +1,76 @@
|
||||
# Subcategories
|
||||
|
||||
Subcategories allow large categories to be broken into smaller groups.
|
||||
|
||||
Example:
|
||||
|
||||
Building Blocks
|
||||
|
||||
- Stone
|
||||
- Wood
|
||||
- Glass
|
||||
- Decorative
|
||||
|
||||
---
|
||||
|
||||
## Creating a Subcategory
|
||||
|
||||
Open Category Management.
|
||||
|
||||
Choose a category.
|
||||
|
||||
Select Subcategories.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Create Subcategory
|
||||
|
||||
Choose Create.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Internal Name
|
||||
|
||||
Enter a unique internal name.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Display Name
|
||||
|
||||
Enter the player-visible name.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Icon
|
||||
|
||||
Select an icon.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
(Optional)
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
---
|
||||
|
||||
## Finished
|
||||
|
||||
The subcategory is now available.
|
||||
|
||||
---
|
||||
|
||||
⬅️ Previous: [Categories](Categories.md)
|
||||
|
||||
➡️ Next: [Depositing Items](Depositing-Items.md)
|
||||
Whitespace-only changes.
Reference in new issue
Block a user