# Custom Setup & Configuration

#### Installation

1. Download the latest release
2. Place the `.jar` file in your server's `plugins` folder
3. Make sure you have Vault or CoinsEngine installed
4. Restart your server
5. Configuration files will be generated in `plugins/XianShop/`

***

#### Configuration Files

| File               | Purpose                        |
| ------------------ | ------------------------------ |
| `messages.yml`     | Customize plugin messages      |
| `sounds.yml`       | Configure sound effects        |
| `commands.yml`     | Configure command aliases      |
| `confirm.yml`      | Customize confirmation dialogs |
| `money-format.yml` | Configure money display format |
| `shop/`            | Shop category configuration    |

***

#### Step 1: Shop Categories

Shop items are organized in the `shop/` folder. Each YAML file is a category.

**Default Categories:**

* `main-shop-gui.yml` - Main menu
* `gear.yml` - Armor & weapons
* `food.yml` - Food items
* `nether.yml` - Nether items
* `end.yml` - End items
* `shards.yml` - SmartSpawner Items

***

#### Step 2: Understanding the Shop Item Structure

```
items:
  item-id:              ← 1. Unique item identifier
    price: 100          ← 2. Price in economy
    slot: 9             ← 3. Inventory slot (9-45)
    material: DIAMOND   ← 4. Item material
    displayname: "..."  ← 5. Display name
    amount: 1           ← 6. Amount per purchase
    lore:               ← 7. Description
      - "..."
    command: "..."      ← 8. Command to execute
```

***

#### Step 3: Configure an Item

**Basic Item**

```yaml
items:
  my-item:
    price: 100
    slot: 10
    material: DIAMOND
    displayname: "&#FFD700Diamond"
    amount: 1
```

**Item with Custom Lore**

```yaml
items:
  my-item:
    price: 500
    slot: 11
    material: GOLD_INGOT
    displayname: "&#FFD700Gold Ingot"
    amount: 10
    lore:
      - "&7Premium gold"
      - "&fPrice: &#FFD700500"
```

**Item with Command**

```yaml
items:
  vip-kit:
    price: 1000
    slot: 12
    material: NETHER_STAR
    displayname: "&#FF5555VIP Kit"
    command: "give %player% diamond_sword 1"
```

***

#### Step 4: Configure GUI Settings

Each shop file has GUI settings:

```yaml
title: "ꜱʜᴏᴘ - ɢᴇᴀʀ"
rows: 3
back-button:
  slot: 18
  material: RED_STAINED_GLASS_PANE
  displayname: "&#f00f0cʙᴀᴄᴋ"
filler:
  enabled: true
  material: GRAY_STAINED_GLASS_PANE
  displayname: "&7 "
```

* `title` - GUI title (supports color codes)
* `rows` - Inventory rows (1-6)
* `back-button` - Button to go back to main menu
* `filler` - Fill empty slots with glass panes

***

#### Step 5: Configure Messages

Open `messages.yml` to customize messages.

**Color Code List:** [Minecraft Wiki - Formatting codes](https://minecraft.wiki/w/Formatting_codes)

**Color Code Generator:** [RGB Birdflop - Minecraft RGB Gradient Creator](https://minecraft.wiki/w/Formatting_codes)

***

#### Step 6: Reload Configuration

After making changes, reload:

```
/xianshop reload
```

Or restart the server.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://xianstudio.gitbook.io/xianstudio-docs/xianshop/custom-setup-and-configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.