1.5.0
Working on Docs now.
This commit is contained in:
1 parent
af44d394f8
commit
3026129bc2
3 files changed
+73
-1
No files matched your search
@@ -54,10 +54,19 @@ There are 3 options in this menu. Picking up the item triggers the next action.
|
|||||||
|
|
||||||
Click on the *Book Shelf*. to open the *Warehouse Category Menu*. If you have
|
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
|
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 *[db-files-templates](../Blank%20Pages/Extras%20Folder.md)* of the plugin.
|
a fully organized and populated warehouse file in the *[db-files-templates](../50%29%20Side%20Pages/Database%20Selection.md)* of the plugin.
|
||||||
1. Hopper. This is your [Auto-Deposit](../50%29%20Side%20Pages/Auto-Deposit.md) section.
|
1. Hopper. This is your [Auto-Deposit](../50%29%20Side%20Pages/Auto-Deposit.md) section.
|
||||||
2. Chest. This is the [UnCategorized Category](../50%29%20Side%20Pages/UnCategorized%20Category.md) section.
|
2. Chest. This is the [UnCategorized Category](../50%29%20Side%20Pages/UnCategorized%20Category.md) section.
|
||||||
|
|
||||||
|
**NOTE:** UnCategorized section will only show if there are "UnCategorized" inside. This behavior can be changed
|
||||||
|
by setting "always-show-uncategorized: true" in the plugins config.yml file.
|
||||||
|
|
||||||
📷 Screenshot
|
📷 Screenshot
|
||||||
|
|
||||||
|
Empty Database
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
Populated Database
|
||||||
|
|
||||||
|

|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
# Database Templates
|
||||||
|
|
||||||
|
RS-Warehouse includes a `db-files-templates` folder inside the plugin folder.
|
||||||
|
|
||||||
|
This folder contains two database templates:
|
||||||
|
|
||||||
|
- `empty_database.db`
|
||||||
|
- `populated_database.db`
|
||||||
|
|
||||||
|
These files can be used to quickly replace the active Warehouse database.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Populated Database
|
||||||
|
|
||||||
|
The `populated_database.db` file is the default database included with RS-Warehouse.
|
||||||
|
It contains the preconfigured categories and items included with the plugin.
|
||||||
|
This database is automatically used as the starting database when RS-Warehouse is installed for the first time.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Empty Database
|
||||||
|
|
||||||
|
The `empty_database.db` file is a completely empty Warehouse database.
|
||||||
|
|
||||||
|
It contains:
|
||||||
|
|
||||||
|
- Zero categories
|
||||||
|
- Zero items
|
||||||
|
|
||||||
|
This can be used if you want to start with a completely blank Warehouse and create your own category and item organization from scratch.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Using a Database Template
|
||||||
|
|
||||||
|
To replace the active Warehouse database with one of the templates:
|
||||||
|
|
||||||
|
1. Stop the server or disable/reload the plugin.
|
||||||
|
2. Open:
|
||||||
|
|
||||||
|
`plugins/RS-Warehouse/db-files-templates/`
|
||||||
|
|
||||||
|
3. Choose the database template you want to use:
|
||||||
|
|
||||||
|
- `populated_database.db`
|
||||||
|
- `empty_database.db`
|
||||||
|
|
||||||
|
4. Make a copy of the selected file.
|
||||||
|
5. Rename the copied file to:
|
||||||
|
|
||||||
|
`database.db`
|
||||||
|
|
||||||
|
6. Copy it into:
|
||||||
|
|
||||||
|
`plugins/RS-Warehouse/`
|
||||||
|
|
||||||
|
7. Overwrite the existing `database.db` file.
|
||||||
|
8. Reload the RS-Warehouse plugin.
|
||||||
|
|
||||||
|
The selected database template will now become the active Warehouse database.
|
||||||
|
|
||||||
|
> **WARNING:** Replacing `database.db` will replace your current Warehouse categories, items, and stored database information. Make a backup of your existing `database.db` before replacing it if you may want to restore it later.
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
Reference in new issue
Block a user