diff --git a/docs/Installation-&-Setup.md b/docs/Installation-&-Setup.md new file mode 100644 index 0000000..0f4c1a4 --- /dev/null +++ b/docs/Installation-&-Setup.md @@ -0,0 +1,74 @@ +Welcome to the # Installation & Setup + +This guide will walk you through installing RS-Warehouse and preparing it for first use. + +--- + +# Requirements + +Before installing RS-Warehouse, ensure your server meets the following requirements. + +- Paper 1.21.x or newer +- Java 21 or newer + +--- + +# Step 1 - Download RS-Warehouse + +Download the latest release of RS-Warehouse. + +--- + +# Step 2 - Install the Plugin + +Copy **RS-Warehouse.jar** into your server's **plugins** folder. + +``` +plugins/ +└── RS-Warehouse.jar +``` + +--- + +📷 Screenshot + +![Plugins Folder](http://192.168.1.58:30008/truenas_admin/RS-Warehouse/raw/branch/main/docs/images/PluginsFolder.png) + +# Step 3 - Start Your Server + +Start your Paper server. + +During startup RS-Warehouse will automatically create its data folder, configuration file, and SQLite database. + +📷 Screenshot + +![Plugins Folder](http://192.168.1.58:30008/truenas_admin/RS-Warehouse/raw/branch/main/docs/images/PluginEnabled.png) + +--- + +# Step 4 - Verify Installation + +After the server has started, verify that the plugin created its data folder. + +Your plugins folder should now contain: + +``` +plugins/ +└── RS-Warehouse/ + ├── config.yml + └── database.db +``` + +📷 Screenshot + +![Plugins Folder](http://192.168.1.58:30008/truenas_admin/RS-Warehouse/raw/branch/main/docs/images/PluginFolderFiles.png) + +--- + +# What's Next? + +RS-Warehouse is now installed. + +The next step is creating your first Warehouse Chest and preparing the warehouse for use. + +➡ Continue to **Creating Your First Warehouse**Wiki. \ No newline at end of file