Setup Guide
Running setup
In your Discord server, run /setup (requires Administrator). The bot replies with an embed and buttons to set:
- Key Channel – Channel where the key redemption embed (Generate Key + Redeem Key) will be posted.
- Log Channel – Channel where key redemptions (and optional expiry messages) are logged.
- Link – The URL where users generate keys (e.g. your claim page). This is the “Generate Key” button target.
- Role – The Discord role given when a user successfully redeems a key (e.g. VIP).
When Key Channel, Link, and Role are set, use Post to create or update the embed in the key channel. If Key Channel or Log Channel were not set, the bot can create an “Access” category and channels for you when you press Post.
How keys are generated
Keys are not generated by the bot. You use an external system (your website, store, or Patreon) that creates keys and associates them with your server. KeyHub gives you a claim code (or link) for your server; you point users to that URL to generate keys. Those keys are then validated and stored so that when a user redeems in Discord, the bot can check the key and assign the role.
The “Generate Key” button in the key channel simply opens your configured link. Users complete the flow there, then return to Discord and use “Redeem Key” to paste the 6-character key.
Linking keys to roles
In /setup, you choose one role (the VIP role). Every successful redemption in that server assigns that role to the user who redeemed. There is one VIP role per server. The bot must have a role higher than that role in the server’s role list to assign it.
How long keys last
- Key validity – A key is valid until it is used (one-time use per key). Invalid or already-used keys are rejected with an error message.
- VIP access after redemption – After a user redeems a key, the assigned role is given for a set time (e.g. 1 hour, depending on bot configuration). When that time expires, the bot removes the role and can post a message in the log channel. The user would need to redeem a new key to get access again.
Exact durations are set in the bot configuration (e.g. user key expiry in hours). Server subscription/approval expiry is separate and controls whether the bot’s features are enabled for the server at all.