diff --git a/docs/01) Getting Started/A) Installation And Setup.md b/docs/01) Getting Started/A) Installation And Setup.md index 83b7bd7..be7171e 100644 --- a/docs/01) Getting Started/A) Installation And Setup.md +++ b/docs/01) Getting Started/A) Installation And Setup.md @@ -32,7 +32,7 @@ plugins/ 📷 Screenshot -![Plugins Folder](../images/PluginsFolder.png) +![Plugins Folder](../images/PluginsFolder.jpg) # Step 3 - Start Your Server @@ -42,7 +42,7 @@ During startup RS-Warehouse will automatically create its data folder, configura 📷 Screenshot -![Plugins Folder](../images/PluginEnabled.png) +![Plugins Folder](../images/PluginEnabled.jpg) --- diff --git a/docs/01) Getting Started/B) Creating A Warehouse Chest.md b/docs/01) Getting Started/B) Creating A Warehouse Chest.md index a782491..572f10f 100644 --- a/docs/01) Getting Started/B) Creating A Warehouse Chest.md +++ b/docs/01) Getting Started/B) Creating A Warehouse Chest.md @@ -25,7 +25,7 @@ with the chest. This will open the *Conversion* Menu. 📷 Screenshot -![ConversionMenu.png](../images/ConversionMenu.png) +![Conversion Menu](../images/ConversionMenu.jpg) --- ## Step 3 - Convert the Chest @@ -34,11 +34,8 @@ In the *Conversion* menu pick up the *Crafting Table*. The action will be cance be converted. **NOTE:** Warehouse chests cannot be broken or damaged. To pick one up, you will need to convert -it back into a normal chest. - -📷 Screenshot - -![MainMenu.png](../images/MainMenu.png) +it back into a normal chest. Also, Sneak + clicking a warehouse chest with a stick is the only way +to access the warehouse admin menu. --- @@ -51,8 +48,7 @@ There are 3 options in this menu. Picking up the item triggers the next action. 📷 Screenshot -![MainMenuNumbered.png](../images/MainMenuNumbered.png) ---- +![Empty Warehouse](../images/Converted.jpg) ## Step 4 - Open the Warehouse @@ -64,4 +60,4 @@ a fully organized and populated warehouse file in the *[db-files-templates](../B 📷 Screenshot -![EmptyWarehouse.png](../images/EmptyWarehouse.png) +![EmptyWarehouse](../images/EmptyWarehouse.jpg) diff --git a/docs/01) Getting Started/C) Categories.md b/docs/01) Getting Started/C) Categories.md index 64357d3..635bccb 100644 --- a/docs/01) Getting Started/C) Categories.md +++ b/docs/01) Getting Started/C) Categories.md @@ -1,37 +1,35 @@ # Categories Categories are used to organize items stored inside the Warehouse. - A well-organized category structure makes it easier for players to browse and find the items they need. - Categories are created and managed through the Warehouse **Administration Menu**. --- ## Opening Category Management -Open a Warehouse Chest and select the **Command Block** to open the **Administration Menu**. - +Open a Warehouse Chest by sneaking and clicking a warehouse chest with a stick and select the **Command Block** to open the **Administration Menu**. From the Administration Menu, select the option for managing categories. 📷 Screenshot +![Plugins Folder](../images/AdminMenu.jpg) +![Plugins Folder](../images/ChestMenu.jpg) --- ## Creating a Category Select **Create Category**. - You will be guided through the information needed to create the category. 📷 Screenshot +![Plugins Folder](../images/CreateCategory.jpg) --- ## Internal Name The first step is entering the category's **Internal Name**. - The Internal Name is used internally by RS-Warehouse and must be unique. For example: @@ -45,13 +43,13 @@ The Internal Name is not normally shown to players. > **NOTE:** Choose the Internal Name carefully. It should be unique and should describe the purpose of the category. 📷 Screenshot +![Plugins Folder](../images/CategoryName.jpg) --- ## Display Name Next, enter the **Display Name**. - The Display Name is the name players will see in the Warehouse Category Menu. Examples: @@ -63,15 +61,14 @@ Examples: - Redstone 📷 Screenshot +![Plugins Folder](../images/CategoryDisplayName.jpg) --- ## Selecting an Icon After entering the category names, choose the material that will represent the category in the Warehouse Category Menu. - RS-Warehouse provides a Material Picker that allows you to select from available Minecraft materials. - Choose an item that best represents the category. For example: @@ -82,16 +79,18 @@ For example: - **Iron Sword** for Combat 📷 Screenshot +![Plugins Folder](../images/CategoryMaterialPicker.jpg) --- ## Adding a Description You can optionally add a description to the category. - The description is displayed as lore when players view the category. - Descriptions can be used to explain what belongs inside the category. +Up to 5 lines can be used. Each book represents one line of lore. +Click the book, the menu will exit. Press "T" to open a chat and simply +type your desired lore into the chat. Upon pressing "enter" the lore will be saved. For example: @@ -100,17 +99,15 @@ Building materials and decorative blocks. ``` 📷 Screenshot +![Plugins Folder](../images/CategoryLore.jpg) --- ## Finishing the Category -Once the category information has been completed, confirm the creation. - +Once the category information has been completed, confirm the creation by picking up the Green Wool Block. The new category will then appear in the **Warehouse Category Menu**. - You can now begin organizing items into the category. - If the category contains a large number of items, you can further organize them using **Subcategories**. --- @@ -118,7 +115,6 @@ If the category contains a large number of items, you can further organize them ## Organizing Your Warehouse You can create as many categories as needed to organize your Warehouse. - A simple example might look like: ```text @@ -133,7 +129,5 @@ Warehouse ``` Items can later be moved between categories as your Warehouse grows and changes. - For information about moving items, see **[Moving Items](../Blank%20Pages/Moving%20Items.md)**. - For information about creating categories within categories, see **[Subcategories](../Blank%20Pages/Subcategories.md)**. \ No newline at end of file diff --git a/docs/02) Depositing And Withdrawing/A) Depositing Items.md b/docs/02) Depositing And Withdrawing/A) Depositing Items.md index ecbc941..6598ddd 100644 --- a/docs/02) Depositing And Withdrawing/A) Depositing Items.md +++ b/docs/02) Depositing And Withdrawing/A) Depositing Items.md @@ -29,7 +29,7 @@ Once you have the desired amount set, click the item in the center of the wool. 📷 Screenshot -![TransactionMenu.png](../images/TransactionMenu.png) +![Transaction Menu](../images/TransactionMenu.jpg) > **NOTE:** Variant items such as damaged, enchanted, and partially filled items have their own transaction menus and are handled separately from the primary item. @@ -58,7 +58,7 @@ Once you close the menu, any item you pick up wil automatically go into the ware 📷 Screenshot -![AutoDeposit.png](../images/AutoDeposit.png) +![Auto Deposit](../images/AutoDeposit.jpg) > **NOTE:** Adding an item to the Auto-Deposit filter does not remove that item from your inventory. diff --git a/docs/02) Depositing And Withdrawing/B) Withdrawing Items.md b/docs/02) Depositing And Withdrawing/B) Withdrawing Items.md index 3a647c7..7a82a1b 100644 --- a/docs/02) Depositing And Withdrawing/B) Withdrawing Items.md +++ b/docs/02) Depositing And Withdrawing/B) Withdrawing Items.md @@ -14,7 +14,7 @@ The normal withdrawal process is: 📷 Screenshot -![TransactionMenu.png](../images/TransactionMenu.png) +![Transaction Menu](../images/TransactionMenu.jpg) --- diff --git a/docs/50) Side Pages/Auto-Deposit.md b/docs/50) Side Pages/Auto-Deposit.md index 38bf920..de2c47e 100644 --- a/docs/50) Side Pages/Auto-Deposit.md +++ b/docs/50) Side Pages/Auto-Deposit.md @@ -20,7 +20,7 @@ The original item is **not removed from your inventory**. 📷 Screenshot -![AutoDeposit.png](../images/AutoDeposit.png) +![Auto Deposit](../images/AutoDeposit.jpg) --- @@ -54,7 +54,7 @@ Open the Auto-Deposit menu to view the items currently configured for automatic 📷 Screenshot -![AutoDeposit.png](../images/AutoDeposit.png) +![Auto Deposit](../images/AutoDeposit.jpg) Items can be removed from the filter when you no longer want them to be automatically deposited by simply picking them up. The item will disappear and will no longer be in the filter. diff --git a/docs/50) Side Pages/UnCategorized Category.md b/docs/50) Side Pages/UnCategorized Category.md index 028a979..a3d4a46 100644 --- a/docs/50) Side Pages/UnCategorized Category.md +++ b/docs/50) Side Pages/UnCategorized Category.md @@ -29,7 +29,7 @@ admin. 📷 Screenshot -![UnassignedCategory.png](../images/UnassignedCategory.png) +![UnassignedCategory.jpg](../images/UnassignedCategory.jpg) --- diff --git a/docs/Home.md b/docs/Home.md index 47a7e48..4529263 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -14,7 +14,7 @@ ### Organization -- [Categories] +- [Categories](01%29%20Getting%20Started/C%29%20Categories.md) - [Subcategories] - [UnCategorized](50%29%20Side%20Pages/UnCategorized%20Category.md) diff --git a/docs/images/AdminMenu.jpg b/docs/images/AdminMenu.jpg new file mode 100644 index 0000000..cb2e8ab Binary files /dev/null and b/docs/images/AdminMenu.jpg differ diff --git a/docs/images/AutoDeposit.jpg b/docs/images/AutoDeposit.jpg new file mode 100644 index 0000000..699016f Binary files /dev/null and b/docs/images/AutoDeposit.jpg differ diff --git a/docs/images/AutoDeposit.png b/docs/images/AutoDeposit.png deleted file mode 100644 index dbcf88a..0000000 Binary files a/docs/images/AutoDeposit.png and /dev/null differ diff --git a/docs/images/CategoryDisplayName.jpg b/docs/images/CategoryDisplayName.jpg new file mode 100644 index 0000000..23559ec Binary files /dev/null and b/docs/images/CategoryDisplayName.jpg differ diff --git a/docs/images/CategoryLore.jpg b/docs/images/CategoryLore.jpg new file mode 100644 index 0000000..6e22af8 Binary files /dev/null and b/docs/images/CategoryLore.jpg differ diff --git a/docs/images/CategoryMaterialPicker.jpg b/docs/images/CategoryMaterialPicker.jpg new file mode 100644 index 0000000..0c34cb0 Binary files /dev/null and b/docs/images/CategoryMaterialPicker.jpg differ diff --git a/docs/images/CategoryName.jpg b/docs/images/CategoryName.jpg new file mode 100644 index 0000000..61c83c6 Binary files /dev/null and b/docs/images/CategoryName.jpg differ diff --git a/docs/images/ChestMenu.jpg b/docs/images/ChestMenu.jpg new file mode 100644 index 0000000..8c07805 Binary files /dev/null and b/docs/images/ChestMenu.jpg differ diff --git a/docs/images/ConversionMenu.jpg b/docs/images/ConversionMenu.jpg new file mode 100644 index 0000000..0b1ec8c Binary files /dev/null and b/docs/images/ConversionMenu.jpg differ diff --git a/docs/images/ConversionMenu.png b/docs/images/ConversionMenu.png deleted file mode 100644 index df03afd..0000000 Binary files a/docs/images/ConversionMenu.png and /dev/null differ diff --git a/docs/images/Converted.jpg b/docs/images/Converted.jpg new file mode 100644 index 0000000..2f23b11 Binary files /dev/null and b/docs/images/Converted.jpg differ diff --git a/docs/images/Converted.png b/docs/images/Converted.png deleted file mode 100644 index 00ea50c..0000000 Binary files a/docs/images/Converted.png and /dev/null differ diff --git a/docs/images/CreateCategory.jpg b/docs/images/CreateCategory.jpg new file mode 100644 index 0000000..6cc12c0 Binary files /dev/null and b/docs/images/CreateCategory.jpg differ diff --git a/docs/images/EmptyWarehouse.jpg b/docs/images/EmptyWarehouse.jpg new file mode 100644 index 0000000..d1bafdc Binary files /dev/null and b/docs/images/EmptyWarehouse.jpg differ diff --git a/docs/images/EmptyWarehouse.png b/docs/images/EmptyWarehouse.png deleted file mode 100644 index 7d71172..0000000 Binary files a/docs/images/EmptyWarehouse.png and /dev/null differ diff --git a/docs/images/MainMenu.png b/docs/images/MainMenu.png deleted file mode 100644 index ed4e646..0000000 Binary files a/docs/images/MainMenu.png and /dev/null differ diff --git a/docs/images/MainMenuNumbered.png b/docs/images/MainMenuNumbered.png deleted file mode 100644 index a269b1c..0000000 Binary files a/docs/images/MainMenuNumbered.png and /dev/null differ diff --git a/docs/images/PluginEnabled.jpg b/docs/images/PluginEnabled.jpg new file mode 100644 index 0000000..d2c4a03 Binary files /dev/null and b/docs/images/PluginEnabled.jpg differ diff --git a/docs/images/PluginEnabled.png b/docs/images/PluginEnabled.png deleted file mode 100644 index 8ce99ac..0000000 Binary files a/docs/images/PluginEnabled.png and /dev/null differ diff --git a/docs/images/PluginsFolder.jpg b/docs/images/PluginsFolder.jpg new file mode 100644 index 0000000..1d3d561 Binary files /dev/null and b/docs/images/PluginsFolder.jpg differ diff --git a/docs/images/PluginsFolder.png b/docs/images/PluginsFolder.png deleted file mode 100644 index 4f31191..0000000 Binary files a/docs/images/PluginsFolder.png and /dev/null differ diff --git a/docs/images/TransactionMenu.jpg b/docs/images/TransactionMenu.jpg new file mode 100644 index 0000000..e00d421 Binary files /dev/null and b/docs/images/TransactionMenu.jpg differ diff --git a/docs/images/TransactionMenu.png b/docs/images/TransactionMenu.png deleted file mode 100644 index 42ea23f..0000000 Binary files a/docs/images/TransactionMenu.png and /dev/null differ diff --git a/docs/images/UnassignedCategory.jpg b/docs/images/UnassignedCategory.jpg new file mode 100644 index 0000000..2afa69c Binary files /dev/null and b/docs/images/UnassignedCategory.jpg differ diff --git a/docs/images/UnassignedCategory.png b/docs/images/UnassignedCategory.png deleted file mode 100644 index 182f9ed..0000000 Binary files a/docs/images/UnassignedCategory.png and /dev/null differ