Getting Started

Getting Started

This is a quickstart guide to the Honeycomb bot.

Adding the Bot to your server

To add the bot to your server, use one of the following two links:

Administrator Link:

This link prevents you needing to give the bot access to private channels.

Reduced Permissions Link:

This link adds the bot with reduced permissions if you don't want to give it full admin permissions

Follow the Discord prompts and the bot will join your server.

Open the settings

To open your server's Honeycomb settings, you need the Administrator permission.

Use the command .setup (or .configure) in a private channel.

From here, you can customise many of the bot's features.

image

Set up role management features

⚠️ Except for the Verification role, other Role management features require Credits to use. You can read more about credits here

⚠️ The Honeycomb role must be higher in your server role list than any roles it is managing. This includes the verification role, the cone of shame role, and any NFT ownership roles. If the Honeycomb role is not higher than the other role, Honeycomb will not be able to use it.

1. Verification Role

If you want to generate whitelists or have Honeycomb manage roles based on NFT ownership, you need to have a verification role on your server. This could be called "Linked" or "Verified" or anything, but this role should not be manually given to any users or be managed by other bots, so it's strongly recommended to create a new role for this.

This IS NOT a role that you want to use for proof of ownership.

After you create the role, click on the Roles option in the Honeycomb Settings, then click "Set Verification Role". You will then be prompted to ping the role you just created.

image

After you respond with the role, Press the Turn On button (Green).

Members with a linked wallet can now use the .verify command to get the verification role.

It is strongly recommended you wait until this notification occurs before continuing.

After this initial role grant, members who have linked wallets can obtain the verification role by using the command .wallets inside the server.

2. Adding Templates and Collections

The next time you visit the Roles menu, it will look something like this:

image

You can add Templates and Collections to your server by using the Add Template and Add Collection buttons. Templates should be added using the following format:collection_name/template_id. Collections should just use the collection name, e.g. sixpm.

For example:

  • To add the SixPM Software collection, you would use sixpm
  • To add the Timekeeper template from the SixPM Software collection, you would use sixpm/239496

3. Adding roles

To add a role, use the Add Role button.

You will be asked to select a role for Honeycomb to manage - It's important that this role only be used by Honeycomb; it should not be manually added to or removed from any members.

You will then be asked to define a rule for the role. When creating rules:

  • Collections are denoted c:collection_name (e.g. c:sixpm)
  • Templates are denoted t:template_id (e.g. t:239496)
  • You have added the templates and collections you use in the rule.

You can create relatively complex rules. Here are some examples:

  • Give the role to anyone holding any NFT from sixpm:
c:sixpm
  • Give the role to anyone holding a Timekeeper NFT:
t:239496
  • Give the role to anyone holding:
    • an NFT from sixpm
    • either an NFT from creek or an NFT from cryptomoonie
c:sixpm and (c:creek or c:cryptomoonie)
  • Give the role to anyone holding:
    • A Timekeeper NFT (Template 239496) AND an NFT from creek or cryptomoonie AND an NFT from official.wax
    • OR

    • An NFT from immersys, puftcreative, and a SixPM Origin Coin (Template 147196)
Note: The following rule should all be a single line. It is split here for readability.


(t:239496 and (c:creek or c:cryptomoonie) and c:official.wax)
or
(c:immersys and c:puftcreative and t:147196)

After you add the rule, you'll be asked to confirm the role and Honeycomb will start managing it for you.