Helios Rust Console Bot Documentation
Shop Role Requirements and Role Rewards
Limit shop access with Discord roles, or sell a role reward players use from their bag.
- Last reviewed
- Maintained by
- Helios RCE
Role-based product settings are configured while creating or editing shop products.
Use them when you want to:
- limit a product to players with a certain Discord role
- sell a Discord role reward that is granted when used
- build VIP, donor, event-pass, or staff-only shop flows
Required Role vs Grant Role
- Category
required_rolerestricts access to the whole category. - Product
rolerequires a role to buy the product. The standard product commands below use this option name. Some specialist commands userequired_role; follow the options shown for that specific command. - Role product
grant_rolechooses the role awarded when the product is used. It does not restrict who can buy it.
These do different jobs. One is an access check. The other is a purchase reward.
If both category and product restrictions are set, buyers must meet both. A VIP category containing a Supporter-only product needs both roles. Manage Server permission does not replace those shopping role checks.
Where You Configure It
You will usually set these options while using:
/product add— including Role products and their reward role/product add-item/product add-kit/product add-cmd/product edit-item/product edit-cmd
Common Uses
- VIP-only products gated by the product's
roleoption - Role rewards for donor or event access
- Staff test products hidden from normal players
- Donor products that unlock a role when used
Example
/product add-item category:"VIP" name:"VIP Starter" item:"wood" quantity:5000 price:1 role:@VIP
/product add category:"Passes" name:"Raid Pass" price:2500 type:Role grant_role:@RaidPass
Create the category first and select the actual roles in Discord's command picker. For a role reward, choose Role as the product type; an ordinary command product is not a role reward just because it has a role-related name.
When does the role arrive?
Normally, a Role purchase goes into /bag. The player uses the item to receive the role, and the item is consumed after a successful grant. An applicable server, category, or product Bypass Bag setting can make it grant at purchase instead. Check those choices before promising immediate delivery.
A standard Role product has no automatic expiry. Calling it a pass does not make it temporary. Arrange a separate removal process if you want time-limited access, and tell buyers about it.
If the role is missing, check for an unused Role item in the player's bag, check the product's grant_role, and confirm the role still exists. Helios needs Manage Roles, and its bot role must be above the role it should assign. Check these before selling a second item or granting a replacement.
Checks before selling
- Test with a linked player who has the required role
- Test with a linked player who does not have the role
- Confirm Helios can assign the grant role if one is used
- Make sure the Helios bot role is above any role it needs to grant
