Store
This guide covers the basics on creating and managing store items.
What store items can do
Store items are capable of doing several different things when they are purchased, called actions. Store items can:
- Add or remove Discord server roles from members
- Add or remove server currency from members
- Add or remove other items from a member's inventory
- Send custom messages when bought or used
Items can also pick a reward at random, such as a mystery crate. See Random outcomes.
A single item can have up to two actions. With Premium, this is increased to five actions per item.
Items can also be configured so that members must meet certain requirements before they can purchase or use an item. A single item can have up to two requirements, or five with Premium. More information on Actions and Requirements can be found later on this page.
How members can interact with store items
Members can, using UnbelievaBoat currency (if enabled):
- Buy items, paid for with their cash balance
- Use items
- Sell items to other members. The other member must accept the offer.
Creating an item
Items can be created using text commands, slash commands, or the dashboard. Only basic information about the item can be set using commands; for full setup of an item the Dashboard must be used. Regardless of the method you choose, members can purchase and use items using either command type, and the items can be modified using the Dashboard later.
Text commands: create-item <name>
Slash commands: /item-setup create
Dashboard: Dashboard → Store → Create Item
You can create up to 25 items. This limit is removed if you subscribe to Premium.
Configuring an item
Items can be customised in many ways. Simply select your item from the Dashboard > Store. More information on item actions, requirements and random outcomes can be found later on this page.
Name
Between 3 and 100 characters. Members use the name to buy and use the item.
Price
How much the item costs. Can be 0 for a free item.
Description
Up to 1,000 characters.
Item icon
Item icons must be of default emoji, or of custom emoji added to the same server the bot is on. Select the icon to the right of the text field to pick an emoji.
Stock
Turn off Unlimited Stock to set how many of the item can be bought in total.
Listed in Store
Whether the item appears in the store and can be bought.
Inventory Item
Whether the item is placed in the member's inventory when bought. If turned off, the item isn't kept, so only actions set to happen when the item is bought will run.
Usable
Whether members can use the item. Turn this off for collectables.
Sellable
Whether members can sell the item to other members.
Reusable
Whether the item stays in the member's inventory when used. If turned off, the item is removed from the inventory each time it is used. Only available for usable inventory items.
Use Cooldown
How long each member must wait between uses of the item, from 1 second up to 1 year. Only available for usable inventory items.
- Reusable items and items with a use cooldown are used one at a time.
- If a member uses the item again before its timed actions have expired, the timers restart. To avoid this, set a use cooldown at least as long as the longest timer.
Max Quantity
For inventory items, the most of this item each member can own. Otherwise, the most that can be bought at once.
Expiry Date
A date and time when the item is automatically deleted.
Update inventory items toggle
Select this option if you want to apply the changes you make to items already purchased by members and in their inventory. Leaving this unchecked means only items bought after the changes were made will be affected.
Any item with "chicken" in its name is used for chicken fighting. Chickens always go into the inventory and can't be used or sold.
Item actions
Actions always happen when members buy or use the item. Select Add Action, then choose what the action does:
- Give cash or Take cash
Add or remove money from the member's cash balance. - Give items or Take items
Add or remove other items from the member's inventory. Multiple items can be added or removed at once. - Give roles or Take roles
Add or remove roles from the member. Multiple roles can be added or removed at once.
For this action to function, the role(s) must be under UnbelievaBoat's highest role in the list in Server Settings > Roles. You must also be able to manage this role to add it to an action.
- Send a message
Send a message to the same channel where the item is bought or used.
Choose when each action happens: When bought, When used, or When bought or used. Items that can't be used only offer When bought.
A single item can have up to two actions. With Premium, this is increased to five actions per item.
Timed actions
An expiry timer can be set for role and item actions. Once time is up, the action is reversed (for example, if the action is to give roles, after time is up the roles are removed). This can be done using the timer icon to the right of the action settings. This feature is active when the icon is green.
Item requirements
Item requirements are requirements that a member must meet before purchasing or using an item. Select Add Requirement, then choose one of the following:
- Has all of these roles, Has any of these roles or Has none of these roles
The member must have all of the roles listed, at least one of them, or none of them. - Has all of these items, Has any of these items or Has none of these items
The member must have in their inventory all of the items listed, at least one of them, or none of them. Specific item quantities can be set next to each item added. - Total balance of at least
The member must have a net worth equal to or greater than this value.
Choose when each requirement is checked: When bought, When used, or When bought or used.
A single item can have up to two requirements. With Premium, this is increased to five requirements per item.
Random outcomes
Random outcomes let an item pick a reward at random, such as a mystery crate: for example, a 70% chance of cash, 25% of a rare item and 5% of an exclusive role. Set them up under Random Outcomes in the item editor, below the actions.
See Random outcomes for how they work and how to set them up.
Item categories
Store items can be organised into custom categories. Items can be filtered by category when using the store command to make it easier to see what is available for purchase.
Setup is done exclusively from the dashboard.
Creating a category
From the Dashboard → Store, select the "All Categories" dropdown → Manage.
Select the Create Category button. Options that can be set for each category:
- Name
- Icon
- Description
Assigning an item to a category
Select an item from the Dashboard → Store, and assign it to a category in the options.
Changing the category order
From the Dashboard → Store, select the "All Categories" dropdown → Manage.
Use the buttons next to the category to change its order.
Deleting a category
From the Dashboard → Store, select the "All Categories" dropdown → Manage.
Select a category, then select Delete.
Deleting all store items
From the Dashboard → Store, select the Options menu in the top right corner. Select the "Delete All Items" option. This cannot be undone!
Deleting everyone's inventory
From the Dashboard → Store, select the Options menu in the top right corner. Select the "Delete All Inventories" option. This cannot be undone!