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 d7096b9..caecb82 100644 --- a/docs/01) Getting Started/B) Creating A Warehouse Chest.md +++ b/docs/01) Getting Started/B) Creating A Warehouse Chest.md @@ -18,57 +18,57 @@ guide first. --- -## Step 1 - Place a Chest +## Step 1 - Convert A Chest -Place a normal chest anywhere in the world. +Place a normal chest anywhere in the world. Then with a stick in your hand SNEAK and strike the chest +with the chest. This will open the *Conversion* Menu. 📷 Screenshot - ---- - -## Step 2 - Open the Chest - -Open the chest. - -📷 Screenshot - +![ConversionMenu.png](../images/ConversionMenu.png) --- ## Step 3 - Convert the Chest -Use the Warehouse administration menu to convert the chest into a Warehouse Chest. +In the *Conversion* menu pick up the *Crafting Table*. The action will be cancelled and the chest will +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) --- -## Step 4 - Verify the Chest +## Step 3A - *Main Chest Menu* +There are 3 options in this menu. Picking up the item triggers the next action. +1. Composter. This Will convert the chest back into a standard chest. +2. Command Block. This will open the chest *Administration Menu* +3. Book Shelf. This will open the *Warehouse Category Menu*. -Verify the chest has successfully become a Warehouse Chest. 📷 Screenshot - +![MainMenuNumbered.png](../images/MainMenuNumbered.png) --- -## Step 5 - Open the Warehouse +## Step 4 - Open the Warehouse -Open the Warehouse Chest. - -The warehouse browser should appear. +Click on the *Book Shelf*. to open the *Warehouse Category Menu*. If you have +not created any categories yet you will only see 2 options in this menu. You can find +a fully organized and populated warehouse file in the *[Extras Folder](../Blank%20Pages/Extras%20Folder.md)* of the plugin. +1. Hopper. This is your [Auto-Deposit](../Blank%20Pages/Auto-Deposit.md) section. +2. Chest. This is the [Unassigned Category](../Side%20Pages/Unassigned%20Category.md) section. 📷 Screenshot - +![EmptyWarehouse.png](../images/EmptyWarehouse.png) --- ## Finished -Your warehouse is now ready for organization. - -Continue with -[Categories](../Categories.md). +You --- ⬅️ Previous: [Installation & Setup](2.%20Installation-&-Setup.md) -➡️ Next: [Categories](../Categories.md) \ No newline at end of file +➡️ Next: [Categories](../Blank%20Pages/Categories.md) \ No newline at end of file diff --git a/docs/Withdrawing-Items.md b/docs/Blank Pages/Auto-Deposit.md similarity index 100% rename from docs/Withdrawing-Items.md rename to docs/Blank Pages/Auto-Deposit.md diff --git a/docs/Categories.md b/docs/Blank Pages/Categories.md similarity index 100% rename from docs/Categories.md rename to docs/Blank Pages/Categories.md diff --git a/docs/Commands.md b/docs/Blank Pages/Commands.md similarity index 100% rename from docs/Commands.md rename to docs/Blank Pages/Commands.md diff --git a/docs/Configuration.md b/docs/Blank Pages/Configuration.md similarity index 100% rename from docs/Configuration.md rename to docs/Blank Pages/Configuration.md diff --git a/docs/Depositing-Items.md b/docs/Blank Pages/Depositing-Items.md similarity index 100% rename from docs/Depositing-Items.md rename to docs/Blank Pages/Depositing-Items.md diff --git a/docs/Blank Pages/Extras Folder.md b/docs/Blank Pages/Extras Folder.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/01) Getting Started/FAQ.md b/docs/Blank Pages/FAQ.md similarity index 88% rename from docs/01) Getting Started/FAQ.md rename to docs/Blank Pages/FAQ.md index e36dc31..0caa5c2 100644 --- a/docs/01) Getting Started/FAQ.md +++ b/docs/Blank Pages/FAQ.md @@ -34,4 +34,4 @@ Please use the repository's **Issues** page. --- -⬅️ Previous: [Configuration](../Configuration.md) \ No newline at end of file +⬅️ Previous: [Configuration](Configuration.md) \ No newline at end of file diff --git a/docs/Blank Pages/Moving Items.md b/docs/Blank Pages/Moving Items.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/Permissions.md b/docs/Blank Pages/Permissions.md similarity index 100% rename from docs/Permissions.md rename to docs/Blank Pages/Permissions.md diff --git a/docs/Subcategories.md b/docs/Blank Pages/Subcategories.md similarity index 100% rename from docs/Subcategories.md rename to docs/Blank Pages/Subcategories.md diff --git a/docs/Blank Pages/Withdrawing-Items.md b/docs/Blank Pages/Withdrawing-Items.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/Side Pages/Unassigned Category.md b/docs/Side Pages/Unassigned Category.md new file mode 100644 index 0000000..7016fe1 --- /dev/null +++ b/docs/Side Pages/Unassigned Category.md @@ -0,0 +1,55 @@ +# The UnCategorized Category + +The **UnCategorized** category is where RS-Warehouse places items that have been discovered by the warehouse but have not yet been assigned to another category. + +This allows items to be added to the warehouse immediately without requiring an administrator to organize every item first. + +> **NOTE:** The UnCategorized category is intended to be a temporary holding area for items that have not yet been organized. +> This category can be enable and disabled in the plugins config.yml file. It is enabled by default. + +--- + +## How Items Become UnCategorized + +When an item is deposited into the warehouse, RS-Warehouse checks whether the item has been assigned to a category. + +If the item has not been assigned to a category, it is placed in the **UnCategorized** category. + +This means you can continue adding items to the warehouse without having to stop and organize each new item as it is discovered. + +--- + +## Viewing UnCategorized Items + +Open the Warehouse and select the **UnCategorized** category. + +The category will display the items that have not yet been assigned to another category. These items can be withdrawn +just like any other item and even deposited. They can be moved by an admin into a *Category* or *SubCategory* by any +admin. + +📷 Screenshot +![UnassignedCategory.png](../images/UnassignedCategory.png) + +--- + +## Keeping the Warehouse Organized + +The UnCategorized category makes it possible to build your warehouse inventory first and organize it later. + +For example, you may discover several new items while playing: + +1. Deposit the items into the Warehouse. +2. The items are automatically placed in **UnCategorized** if they have not yet been categorized. +3. Continue using the warehouse normally. +4. When convenient, open **UnCategorized**. +5. Move the items into their appropriate categories. + +This allows the warehouse to remain usable without requiring constant administrative organization. + +> **IMPORTANT:** Items in Unassigned are still part of the warehouse inventory. Unassigned simply means that they have not yet been organized into a specific category. + +--- + +## Finished + +Once an item has been moved to its appropriate category, it will appear there instead of in Unassigned. \ No newline at end of file