diff --git a/docs/Categories.md b/docs/Categories.md new file mode 100644 index 0000000..a8e0cfe --- /dev/null +++ b/docs/Categories.md @@ -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](Creating-a-Warehouse-Chest.md) + +➡️ Next: [Subcategories](Subcategories.md) \ No newline at end of file diff --git a/docs/Commands.md b/docs/Commands.md new file mode 100644 index 0000000..6e52fbe --- /dev/null +++ b/docs/Commands.md @@ -0,0 +1,11 @@ +# Commands + +| Command | Description | +|---------|-------------| +| *(To be completed)* | | + +--- + +⬅️ Previous: [Permissions](Permissions.md) + +➡️ Next: [Configuration](Configuration.md) \ No newline at end of file diff --git a/docs/Configuration.md b/docs/Configuration.md new file mode 100644 index 0000000..ce8cd9a --- /dev/null +++ b/docs/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](FAQ.md) \ No newline at end of file diff --git a/docs/Creating-a-Warehouse-Chest.md b/docs/Creating-a-Warehouse-Chest.md new file mode 100644 index 0000000..03d6fb6 --- /dev/null +++ b/docs/Creating-a-Warehouse-Chest.md @@ -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](Installation-&-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](Installation-&-Setup.md) + +➡️ Next: [Categories](Categories.md) \ No newline at end of file diff --git a/docs/Depositing-Items.md b/docs/Depositing-Items.md new file mode 100644 index 0000000..000ef54 --- /dev/null +++ b/docs/Depositing-Items.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) \ No newline at end of file diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 0000000..0caa5c2 --- /dev/null +++ b/docs/FAQ.md @@ -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) \ No newline at end of file diff --git a/docs/Permissions.md b/docs/Permissions.md new file mode 100644 index 0000000..38079b2 --- /dev/null +++ b/docs/Permissions.md @@ -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) \ No newline at end of file diff --git a/docs/Subcategories.md b/docs/Subcategories.md new file mode 100644 index 0000000..28e2f80 --- /dev/null +++ b/docs/Subcategories.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) \ No newline at end of file diff --git a/docs/Withdrawing-Items.md b/docs/Withdrawing-Items.md new file mode 100644 index 0000000..e69de29