Repository navigation
Configuration
Brendon Butler edited this page Aug 26, 2023
·
5 revisions
This page will explain the Shops configuration so that you're able to configure the Shops settings as needed.
I will reference keys in node-notation.
For example: max-owned-stores would be referenced as store.max-owned-stores in this document.
store:
max-owned-stores: 3
min-dimensions:
x: 3
y: 3
z: 3
max-dimensions:
x: 0
y: 0
z: 0
min-volume: 27
max-volume: 4096
off-limits:
- world(world),start(-20.000000,-20.000000,-20.000000),end(20.000000,20.000000,20.000000)
- world(world_nether),start(-20.000000,-20.000000,-20.000000),end(20.000000,20.000000,20.000000)
messages:
NO_PERMS_CMD: §cDon't even try it!§fYou don't have permission to do that.
NOT_BUYING: §cThe store is not buying §6{material}§c at this time!| Key | Default Value | Type | Description |
|---|---|---|---|
| store.max-owned-stores | 1 | Whole Number | Sets the maximum number of stores that a player can be the owner of. |
| store.min-dimensions | x: 3 y: 3 z: 3 |
Decimal Numbers | Sets the minimum x, y, and z size that a store can be, which is based off the delta of the coordinates entered (ex: (10, 20, 10), (15, 23, 5) would have a delta/difference of (5, 3, 5) which is greater than or equal to the minimum size, and would allow the creation of the store). Setting these values to 0 will ignore the minimum dimensions. |
| store.max-dimensions | x: 0 y: 0 z: 0 |
Decimal Numbers | Sets the maximum x, y, and z size that a store can be, which is based off the delta of the coordinates entered (ex: (10, 20, 10), (15, 23, 5) would have a delta/difference of (5, 3, 5) which is less than or equal to the maximum size of infinite, and would allow the creation of the store). Setting these values to 0 will ignore the minimum dimensions. |
| store.min-volume | 27 | Decimal Number | Sets the minimum volume of the store (delta x * delta y * delta z) (ex: (10, 20, 10), (15, 23, 5) would have a delta/difference of (5, 3, 5) which is a volume of 75. Setting these values to 0 will ignore the minimum dimensions. |
| store.max-volume | 4096 | Decimal Number | Sets the maximum volume of the store (delta x * delta y * delta z) (ex: (10, 20, 10), (15, 23, 5) would have a delta/difference of (5, 3, 5) which is a volume of 75. Setting these values to 0 will ignore the maximum dimensions. |
| store.off-limits | world(world) start(-20.000000,-20.000000,-20.000000) end(20.000000,20.000000,20.000000) | World, Start & End Coordinates | Sets any off-limits areas within the defined world. This will prevent players from creating stores within or containing these areas. This can be beneficial if you have a protected spawn area. To define an area, include world({WORLD_NAME}) start({START_COORD}) end({END_COORD}) in the list item. |
| messages |
|
Text (with wildcard support) | Reconfigures the default messages that are sent to players by this plugin. See Message Configuration to see what values are configurable and what wildcard options are available. |
| Message Key | Default Value | Available Wildcards |
|---|---|---|
| ADD_SUCCESS | §aYou have successfully added §6{material}§a to the store! |
{material}, {sender}, {store}, {quantity}
|
| ADD_SUCCESS_QUANTITY | §aYou have successfully added §6{quantity} §aof §6{material}§a to the store! |
{material}, {sender}, {store}, {quantity}
|
| ADDED_MATERIAL_TO_STORE | §aYou have successfully added §6{material}§a to the store with a buy price of §6{buy-price}§a, a sell price of §6{sell-price}§a, and a max quantity of §6{max-quantity}§a! |
{material}, {sender}, {store}, {quantity}, {buy-price}, {sell-price}, {max-quantity}
|
| ADDED_MATERIAL_TO_STORE_QUANTITY | §aYou have successfully added §6{quantity}§a of §6{material}§a to the store with a buy price of §6{buy-price}§a, a sell price of §6{sell-price}§a, and a max quantity of §6{max-quantity}§a! |
{material}, {sender}, {store}, {quantity}, {buy-price}, {sell-price}, {max-quantity}
|
| PRICE | §9Price: §a{cost} |
{material}, {sender}, {store}, {quantity}, {cost}
|
| BUY_SUCCESS | §aSuccess! You have purchased §6{quantity}§a of §6{material}§a for §6{cost}§a. |
{material}, {sender}, {store}, {quantity}, {cost}
|
| DEPOSIT_INF_FUNDS | §aThis store has infinite funds, depositing funds isn't necessary! |
{sender}, {store}, {amount}
|
| DEPOSIT_SUCCESS | §aYou have successfully deposited §6{amount}§a to the store! |
{sender}, {store}, {amount}
|
| INSUFFICIENT_AMOUNT_PLAYER | §cYou have an insufficient amount! |
{material}, {type}, {player}, {store}, {quantity}, {cost}
|
| INSUFFICIENT_FUNDS_PLAYER | §cYou have insufficient funds! |
{material}, {type}, {player}, {store}, {quantity}, {cost}
|
| INSUFFICIENT_FUNDS_STORE | §cThe store has insufficient funds! |
{material}, {type}, {player}, {store}, {quantity}, {cost}
|
| INSUFFICIENT_INV_PLAYER | §cYou have insufficient inventory space! |
{material}, {type}, {player}, {store}, {quantity}, {cost}
|
| INSUFFICIENT_INV_STORE | §cThe store currently doesn't have enough §6{material}§c! |
{material}, {type}, {player}, {store}, {quantity}, {cost}
|
| INSUFFICIENT_STOCK_STORE | §cThe store has insufficient stock! |
{material}, {type}, {player}, {store}, {quantity}, {cost}
|
| INSUFFICIENT_STOCK_PLAYER | §cYou don't have enough of this item to stock the store, try leaving out the quantity and adding it later! |
{material}, {type}, {player}, {store}, {quantity}, {cost}
|
| INVALID_ARG_CNT | §cInvalid number of arguments! | {sender} |
| INVALID_PAGE_NUM | §cInvalid page number! |
{sender}, {store}
|
| INVALID_QUANTITY | §cInvalid quantity ({quantity})! |
{material}, {sender}, {store}, {quantity}, {cost}
|
| INVALID_MATERIAL | §cInvalid material ({material})! |
{material}, {sender}, {store}, {quantity}, {cost}
|
| MATERIAL_EXISTS_STORE | §cThis material already exists in the store, use /shop update {material} to update this item |
{material}, {sender}, {store}, {quantity}, {buy-price}, {sell-price}, {max-quantity}
|
| MATERIAL_MISSING_STORE | §cThis material doesn't currently exist in the store, use /shop add {material} to add this item |
{material}, {sender}, {store}, {quantity}
|
| NO_PERMS_CMD | §cYou do not have permission to use this command! | |
| NO_PERMS_CREATE_OTHER | §cYou do not have permission to create stores for other players! |
{sender}, {target}, {max-stores}
|
| NO_PERMS_INF_FUNDS | §cYou do not have permission to set infinite funds in your store! |
{material}, {sender}, {store}
|
| NO_PERMS_INF_STOCK | §cYou do not have permission to set infinite stock in your store! |
{material}, {sender}, {store}, {quantity}
|
| NO_PERMS_LOCATION | §cYou do not have permission to set the location for your store! |
{sender}, {store}
|
| NO_STORE_FOUND | §cYou are not currently in a store! |
{sender}, {store}
|
| NOT_BUYING | §cThe store is not buying any of these at this time! |
{material}, {sender}, {store}, {quantity}, {cost}
|
| NOT_BUYING_ANYMORE | §cThe Store is not buying any more of these at this time! |
{material}, {sender}, {store}, {quantity}, {cost}
|
| NOT_SELLING | §cThe store is not selling any of these at this time! |
{material}, {sender}, {store}, {quantity}, {cost}
|
| NOT_OWNER | §cYou are not the owner of this store, you cannot perform this command! |
{sender}, {store}, {amount}
|
| ONLY_PLAYERS_CMD | §cOnly players can use this command! |
{sender}, {target}, {max-stores}
|
| PLAYER_NOT_FOUND | §cPlayer ({target}) not found! |
{material}, {sender}, {store}, {quantity}
|
| REMOVE_INSUFFICIENT_INV_PLAYER | §cYou don't have enough inventory space to remove §6{material}§c from your store, please try specifying a quantity then removing once the store quantity is lesser! |
{material}, {sender}, {store}, {quantity}
|
| REMOVE_SUCCESS | §aYou have successfully removed §6{material}§a from the store! |
{material}, {sender}, {store}, {quantity}
|
| REMOVE_SUCCESS_QUANTITY | §aYou have successfully removed §6{quantity} §aof §6{material}§a from the store! |
{material}, {sender}, {store}, {quantity}
|
| SELL_SUCCESS | §aSuccess! You have sold §6{quantity}§a of §6{material}§a for §6{cost}§a. |
{material}, {sender}, {store}, {quantity}, {cost}
|
| STORE_CREATE_SUCCESS | §aYou have successfully created §6{store}§a! |
{sender}, {max-stores}, {target}, {max-x}, {max-y}, {max-z}, {min-x}, {min-y}, {min-z}, {limit-max-x}, {limit-max-y}, {limit-max-z}, {limit-min-x}, {limit-min-y}, {limit-min-z}, {volume}, {limit-max-vol}, {limit-min-vol}, {store}
|
| STORE_CREATE_SUCCESS_OTHER_PLAYER | §aYou have successfully created §6{store}§a for §6{target}§a! |
{sender}, {max-stores}, {target}, {max-x}, {max-y}, {max-z}, {min-x}, {min-y}, {min-z}, {limit-max-x}, {limit-max-y}, {limit-max-z}, {limit-min-x}, {limit-min-y}, {limit-min-z}, {volume}, {limit-max-vol}, {limit-min-vol}, {store}
|
| STORE_CREATE_FAIL_MAX_DIMS | §cYou can't create a store that large!§f Maximum dimensions: ({limit-max-x}, {limit-max-y}, {limit-max-z}). |
{sender}, {max-stores}, {target}, {max-x}, {max-y}, {max-z}, {min-x}, {min-y}, {min-z}, {limit-max-x}, {limit-max-y}, {limit-max-z}, {limit-min-x}, {limit-min-y}, {limit-min-z}
|
| STORE_CREATE_FAIL_MIN_DIMS | §cYou can't create a store that small!§f Minimum dimensions: ({limit-min-x}, {limit-min-y}, {limit-min-z}). |
{sender}, {max-stores}, {target}, {max-x}, {max-y}, {max-z}, {min-x}, {min-y}, {min-z}, {limit-max-x}, {limit-max-y}, {limit-max-z}, {limit-min-x}, {limit-min-y}, {limit-min-z}
|
| STORE_CREATE_FAIL_MAX_STORES | §cYou can't create any more stores!§f Maximum stores: {max-stores}. |
{sender}, {max-stores}
|
| STORE_CREATE_FAIL_MAX_VOL | §cYou can't create a store that large!§f Maximum volume: {limit-max-vol}. |
{sender}, {max-stores}, {target}, {max-x}, {max-y}, {max-z}, {min-x}, {min-y}, {min-z}, {limit-max-x}, {limit-max-y}, {limit-max-z}, {limit-min-x}, {limit-min-y}, {limit-min-z}, {volume}, {limit-max-vol}, {limit-min-vol}
|
| STORE_CREATE_FAIL_MIN_VOL | §cYou can't create a store that small!§f Minimum volume: {limit-min-vol}. |
{sender}, {max-stores}, {target}, {max-x}, {max-y}, {max-z}, {min-x}, {min-y}, {min-z}, {limit-max-x}, {limit-max-y}, {limit-max-z}, {limit-min-x}, {limit-min-y}, {limit-min-z}, {volume}, {limit-max-vol}, {limit-min-vol}
|
| STORE_CREATE_FAIL_OFFLIMITS | §cYou can't create a store within this area (off limits)! |
{sender}, {max-stores}, {target}, {max-x}, {max-y}, {max-z}, {min-x}, {min-y}, {min-z}, {limit-max-x}, {limit-max-y}, {limit-max-z}, {limit-min-x}, {limit-min-y}, {limit-min-z}, {volume}, {limit-max-vol}, {limit-min-vol}
|
| STORE_CREATE_FAIL_OVERLAPS | §cYou can't create a store within this area (intersects another store)! |
{sender}, {max-stores}, {target}, {max-x}, {max-y}, {max-z}, {min-x}, {min-y}, {min-z}, {limit-max-x}, {limit-max-y}, {limit-max-z}, {limit-min-x}, {limit-min-y}, {limit-min-z}, {volume}, {limit-max-vol}, {limit-min-vol}
|
| STORE_DELETE_FAIL | §cSomething went wrong when attempting to delete the store! |
{sender}, {store}
|
| STORE_DELETE_SUCCESS | §aYou have successfully deleted §6{store}§a! |
{sender}, {store}
|
| STORE_DELETE_INSUFFICIENT_INV_PLAYER | §cYou don't have enough inventory space to delete the store, please try removing items first or use the '-f' flag to ignore inventory! |
{sender}, {store}
|
| STORE_GOODBYE_MSG | §9We hope to see you again! |
{player}, {store}
|
| STORE_MULTI_MATCH | §cMultiple stores matched, please specify the store's UUID! |
{sender}, {store}
|
| STORE_NO_ITEMS | §cThis store is currently empty! |
{sender}, {store}
|
| STORE_NO_STORE_FOUND | §cCould not find a store with the name and/or UUID of: §6{store}§c! |
{sender}, {store}
|
| STORE_TRANSFER_FAIL_MAX_STORES | §c{target} can't have any more stores!§f Maximum stores: {max-stores}. |
{sender}, {target}, {max-stores}, {store}
|
| STORE_TRANSFER_SUCCESS | §aYou have successfully transferred §6{store}§a to player §6{target}§a! |
{sender}, {target}, {max-stores}, {store}
|
| STORE_UPDATE_SUCCESS | §aYou have successfully updated §6{arg1}§a to §6{arg2}§a in {store}! |
{sender}, {store}
|
| STORE_UPDATE_SUCCESS_2 | §aYou have successfully updated §6{arg2}§a to §6{arg3}§a in {store}! |
{sender}, {store}
|
| STORE_UPDATE_SUCCESS_LOCATION | §aYou have successfully updated the location of {store} to ({x1}, {y1}, {z1}) ({x2}, {y2}, {z2}) in {world}! |
{sender}, {store}, {x1}, {y1}, {z1}, {x2}, {y2}, {z2}
|
| STORE_UPDATE_NO_STOCK | §cPlease ensure there is no stock in the store for this item and try again! |
{sender}, {store}
|
| STORE_WELCOME_MSG | §9Welcome to §6{store}§9! |
{player}, {store}
|
| WITHDRAW_SUCCESS | §aYou have successfully withdrawn §6{amount}§a from the store! |
{sender}, {store}, {amount}
|
| WORLD_NOT_FOUND | §cCould not find world ({world})! |
{sender}, {store}, {world}
|