Shop Admin Panel
The Shop Admin Panel is a full in-game UI for managing all shops on your server. It allows you to create, edit, and delete shops and their items without editing JSON files directly.
Accessing the Admin Panel
The Shop Admin Panel is accessible through the KyuubiSoft Admin Panel:
- Run
/ksadminin-game (requireskyuubisoft.adminpermission). - Select Shop Admin from the module list.
Shop List View
The main view displays all registered shops in a paginated list.
Shop List Columns
| Column | Description |
|---|---|
| ID | Unique shop identifier (matches the JSON filename) |
| Title | Display title (may be a localization key) |
| Currency | Currency used for purchases |
| Items | Number of items in the shop |
| Daily | Daily rotation size (0 = fixed catalog) |
| Sell | Whether selling is enabled |
Shop List Actions
| Button | Description |
|---|---|
| Add Shop | Create a new shop from scratch |
| Edit | Open the selected shop for editing |
| Delete | Delete the selected shop (with confirmation dialog) |
| Open Detail | Switch to the detail view for the selected shop |
Shop Detail View
The detail view provides inline editing of all shop properties and items.
Shop Properties
| Field | Description |
|---|---|
| ID | Unique shop identifier. Cannot be changed after creation. |
| Title | Display title. Can be an i18n localization key or plain text. |
| Currency | Currency ID used for purchases (e.g., quest_tokens, item:Ingredient_Bar_Gold). |
| Daily Size | Number of items shown per day. 0 = fixed catalog showing all items. |
| Items/Page | Items displayed per page in the shop UI (default: 9 for a 3x3 grid). |
Buy/Sell Configuration
The detail view includes a Sell Configuration section:
| Field | Description |
|---|---|
| Buy | Toggle whether buying is enabled (ON/OFF). |
| Sell | Toggle whether selling is enabled (ON/OFF). |
| Price % | Default sell price as a percentage of the buy price (e.g., 50 means items sell for half their buy cost). |
| Sell Currency | Currency used for sell payouts. Leave empty to use the shop's buy currency. |
| Whitelist | Comma-separated list of item IDs that can be sold. Leave empty to allow all items. |
| Blacklist | Comma-separated list of item IDs that can never be sold. |
Item Management
The detail view shows all items in the shop with pagination and search.
Item List Columns
| Column | Description |
|---|---|
| Item ID | Hytale item ID |
| Name | Display name |
| Cost | Purchase price |
| Sell | Sell price (0 = calculated from percentage) |
| Qty | Quantity received per purchase |
| Weight | Selection weight for daily rotation |
| Category | Optional grouping category |
| Limit | Max purchases per player per day |
Item Editor
Click Add Item or select an existing item to open the item editor overlay.
| Field | Description |
|---|---|
| Item ID | Hytale item ID (e.g., Food_Bread, Weapon_Sword_Iron). |
| Name | Display name (i18n key or plain text). |
| Description | Short description shown in the shop UI. |
| Quantity | How many items the player receives per purchase. |
| Cost | Price in the shop's currency. |
| Sell Price | Explicit sell price. 0 uses the percentage fallback. |
| Max Sells | Maximum sells per player per day. 0 = unlimited. |
| Weight | Selection weight for daily rotation (higher = more likely). |
| Max Purch | Maximum purchases per player per day. 0 = unlimited. |
| Category | Optional category for filtering. |
| Permission | Permission required to purchase this item (optional). |
| Command | Command to execute instead of granting an item. Supports {player} placeholder. |
| Run as | Whether the command runs as Server (console) or Player. |
When a Command is set, the shop executes that command instead of granting a physical item. This is useful for giving non-item rewards like XP, currency, or triggering events. The {player} placeholder is replaced with the buyer's username.
Workflow Example
Creating a New Shop
- Open
/ksadminand select Shop Admin. - Click Add Shop.
- Fill in the shop ID, title, and currency.
- Click Save to create the empty shop.
- Click Open Detail on your new shop.
- Click Add Item to add items to the shop.
- Configure each item's price, quantity, and other properties.
- Click SAVE SHOP to persist changes to disk.
Enabling Sell Mode
- Open a shop's detail view.
- In the Sell Configuration section, toggle Sell to ON.
- Set the Price % (e.g.,
50for half price). - Optionally configure a whitelist/blacklist for sellable items.
- Click SAVE SHOP.
Players can now use /ksshop sell <shopId> or interact with an NPC linked to the shop to sell items.
Deleting a Shop
- Select the shop in the shop list.
- Click Delete.
- Confirm in the dialog that appears.
Deleting a shop removes both the runtime registration and the JSON file on disk. This action cannot be undone.
Saving
All changes made in the admin panel are saved to the shop's JSON file on disk when you click SAVE SHOP. The runtime configuration is also updated immediately, so players see the changes without a server restart or reload.