# 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. Install ProtocolLib for client-side worth lore
5. Restart your server
6. Configuration files will be generated in `plugins/XianSell/`

***

#### Configuration Files

| File               | Purpose                        |
| ------------------ | ------------------------------ |
| `price.yml`        | Item sell prices (extensive)   |
| `messages.yml`     | Customize plugin messages      |
| `sounds.yml`       | Configure sound effects        |
| `commands.yml`     | Configure command aliases      |
| `blacklist.yml`    | Items that cannot be sold      |
| `worth-lore.yml`   | Worth lore display settings    |
| `money-format.yml` | Configure money display format |

***

#### Step 1: Understanding Price Configuration

The `price.yml` file contains categories of items and their sell prices.

```
armortools:          ← Category name
  DIAMOND_HELMET: 30 ← Material: Price
  DIAMOND_CHESTPLATE: 40
```

**Categories:**

* `armortools` - Armor, tools, weapons
* `blocks` - Building blocks
* `food` - Food items
* `brewing` - Potions, brewing items
* `decorations` - Decorative items
* `redstone` - Redstone components
* `misc` - Miscellaneous items

***

#### Step 2: Configure Custom Prices

Add custom prices to any category:

```yaml
armortools:
  CUSTOM_ITEM: 100
  MY_CUSTOM_SWORD: 500
```

**Note:** For enchanted items, use:

```yaml
ENCHANTED_BOOK: 10
# Or specific enchantments
ENCHANTED_BOOK: sharpness:5: 50
```

***

#### Step 3: Configure Blacklist

Open `blacklist.yml` to prevent selling certain items.

```yaml
blacklist:
  items:
    - DIAMOND_BLOCK
    - EMERALD_BLOCK
  materials:
    - BEDROCK
    - COMMAND_BLOCK
```

* `items` - Specific item IDs
* `materials` - Material types

***

#### Step 4: Worth Lore Configuration

Open `worth-lore.yml` to configure how item values display.

**With ProtocolLib (Recommended):**

* Worth lore shows on client-side
* Does not affect item stacking
* Requires ProtocolLib installed

**Without ProtocolLib:**

* Uses NBT tags
* May affect item stacking so we suggest you to disable this feature if you dont have ProtocolLib installed

```yaml
settings:
  enabled: true
  format:
    value: "&7Worth: &#55FF55%value%"
```

***

#### 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:

```
/xiansell 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/xiansell/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.