> For the complete documentation index, see [llms.txt](https://docs.xshyo.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xshyo.us/premium-plugins/shopmaster/installation.md).

# Installation

## 📦 ShopMaster - Installation Guide

Learn how to install and set up ShopMaster on your Minecraft server in just a few steps. This guide covers requirements, installation, dependencies, and basic configuration.

***

### ✅ Prerequisites

Before installing ShopMaster, make sure your server meets the following requirements:

* Minecraft Server: **Spigot**, **Paper, Folia**, or a compatible fork (version **1.16.5 or higher**)
* Java Version: **Java 11 or higher**

***

### 🧰 Installation Process

#### 🔽 Step 1: Download the Plugin

Visit the official ShopMaster page and download the latest `ShopMaster.jar` file.

#### ⚠️ Step 2: Prepare the Server

> Make sure your server is **completely shut down** before installing the plugin to avoid data loss or loading issues.

#### 📂 Step 3: Plugin Installation

1. Navigate to the `/plugins` directory in your server files.
2. Place the downloaded `ShopMaster.jar` file into this folder.

#### ▶️ Step 4: Start the Server

* Launch your server as usual.
* ShopMaster will automatically generate its folder: `/plugins/ShopMaster/`
* Check the console for confirmation messages indicating the plugin loaded successfully.

***

### 🔗 Dependencies

#### Required

| Plugin    | Purpose                            |
| --------- | ---------------------------------- |
| **Vault** | Handles economy system integration |

#### Optional (Soft Dependencies)

ShopMaster works seamlessly with several other plugins to enhance features:

| Plugin               | Feature                                          |
| -------------------- | ------------------------------------------------ |
| **PlaceholderAPI**   | Enables use of placeholders in messages and GUIs |
| **TokenManager**     | Adds support for token-based economy             |
| **PlayerPoints**     | Allows using points as currency                  |
| **BreweryX**         | Compatibility with custom potion recipes         |
| **ExecutableItems**  | Custom items with effects and abilities          |
| **ExecutableBlocks** | Shop items on interactive blocks                 |
| **MMOItems**         | Full support for MMOItems RPG system             |
| **ItemsAdder**       | Works with custom items and textures             |
| **Oraxen**           | Integration for Oraxen-based custom models       |

***

### ⚙️ Initial Configuration

After installation, go to `/plugins/ShopMaster/` to find your configuration files.

#### 🔧 Quick Start

1. Open `config.yml` and adjust global plugin settings.
2. Edit `messages.yml` to customize shop messages.
3. Use the command `/adminshop reload` to apply changes without restarting the server.

***

For advanced usage, check out our full documentation or join the **ShopMaster Support Discord** for help and updates.
