# SETUP: User

### Check if DeluxeShop is installed correctly

After you have put the DeluxeShop.jar into your plugins folder, start your server.

Please make sure that you have at least one of the required plugins installed, that want to be expanded by DeluxeShop. Following plugins already support DeluxeShop:

* DeluxeCombat
* TrickOrTreat

After your server has been enabled, go ingame and run following command:

```
/deluxeShop hooks
```

If a message pops up that lists the hooked plugins, *you are ready to go*!

![A correct setup looks like this.](https://1950188350-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MBFjnZJyk6pQ-lyCt1f%2F-MJv9rftvpgQEnqfl667%2F-MJvBIKf7AGHY-gYpPlt%2Fgrafik.png?alt=media\&token=e9c816dc-1109-4a2f-b751-b9f3eea9cd1b)

If you see following message, *you can't use* DeluxeShop any further.

![If this message pops up, you can't use DeluxeShop on your server.](https://1950188350-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MBFjnZJyk6pQ-lyCt1f%2F-MJv9rftvpgQEnqfl667%2F-MJvBqJzUARRk6RxCOjo%2Fgrafik.png?alt=media\&token=5ab40b43-13e5-42b8-b663-485b2b94ac5e)

### **Setting up a shop**

After you have checked if you can use DeluxeShop you are ready to go and can setup your shop.

To create a layout for your shop, run following command:

```
/deluxeshop editShop
```

After that, a inventory should pop up. You now can put any **item** you want into the inventory. Everything is possible so live your creativity and design the shop to your likings.

After you have put in any placeholders such as black glass panes, and your shop items you can close the inventory. Following message should pop up:

![The shop has been successfully saved.](https://1950188350-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MBFjnZJyk6pQ-lyCt1f%2F-MJv9rftvpgQEnqfl667%2F-MJvD_nRUINjr3_KUJrA%2Fgrafik.png?alt=media\&token=e300314f-fa95-4ca5-bf71-36375b8b7172)

Now its time to configure the items you like to sell. For this, run following command:

```
/deluxeshop editItems
```

Now, the same menu should pop up as last time you have setup the shop layout. But now, you can't put any item into the inventory, you can only click on those items you have put in.

If you have clicked on an item you would like to sell, the configuration page should pop up. You then find many options to customize the shop item.

You have following options:

| Option            | Description                                                                                                                                                                                                                                                                                |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Add to inventory  | Decide, if the item, after it has been purchased, should be added to the players inventory.                                                                                                                                                                                                |
| Console commands  | Run commands, which get executed, when a player buys this item. (Placeholders: %player% -> Returns the name of the player)                                                                                                                                                                 |
| Price             | The amount of currency, that will be removed from the players account, when he purchases the item.                                                                                                                                                                                         |
| Currency          | The currency, that will be used, when the player purchases the item. Please note that only currencies will appear from plugins, that are hooked into DeluxeShop. **You need to click on this option in order to make the item work. There is no auto select, so please click the option.** |
| Plugin            | The plugin, that will handle the purchase. Each plugin has its own currencies and requirements you can apply on the shop item. **You also need to click on the option to make the item work.**                                                                                             |
| Requirement type  | The plugin that are hooked into DeluxeShop can offer requirements the player needs to meet, in order to purchase the item. e.g that the player needs a certain amount of kills in order to buy the item.                                                                                   |
| Requirement value | The exact value the player needs to have from a certain requirement, in order to buy the item                                                                                                                                                                                              |

After you have setup an item, you can close the inventory and type in /deluxeshop editItems again to setup other items you would like to sell.

### Linking the shop to a Citizen NPC

If you don't want your players to run the open command for the shop, you can add a trait to a npc that will open the shop, if you right-click the npc.

For that, simply select the NPC and apply the trait to it:

```
1) /npc sel

2) /trait deluxeshop
```

Done!
