# Engagement Bot Setup

## Currency Bot Docs

## Configuring the currency Features

Unlike other Whop services, the currency features are configured completely within discord. To begin setup type the `/config` command. This command requires administrator permission.

After running the command you will be prompted to set a name for your server currency. This can always be changed.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2F7MZj8bwwdYRQ3dnBxSQz%2FScreen_Shot_2022-09-12_at_11.41.24_AM.png?alt=media&#x26;token=e5757a1a-ed06-4708-bfad-cb7bf7a83f2e" alt=""><figcaption></figcaption></figure>

Once you have set a name for your currency you can begin to configure the bot. No features are required, so you have the ability to choose exactly how your currency is given out. All currency given out from messages and reactions will be randomized within 10% of the specified currency amount.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2Fz38H2ZGNBGm6zzFOai7A%2FScreen_Shot_2022-09-12_at_11.42.24_AM.png?alt=media&#x26;token=1d00caff-f44e-498f-babd-ae822a7711ce" alt=""><figcaption></figcaption></figure>

## Chat

The chat feature is designed to reward members who are active in chat.

**Currency** **Per Message:** The amount of currency that is given for every eligible message.

**Time Interval:** The minimum amount of time (in seconds) between messages.

**Message Interval:** The minimum amount of messages that must be sent in order to earn currency. For example, with a message interval of 2, every 3rd message would gain currency.

**Whitelisted Categories:** Only messages in these categories will earn currency.

**Blacklisted Categories:** Messages in these categories will not earn currency.

**Whitelisted Channels:** Only messages sent in these channels will be eligible for currency.

**Blacklisted Channels:** No messages sent in these channels will be eligible for currency.

**Whitelisted Roles:** Only members with these roles can gain currency from messages.

**Blacklisted Roles:** Any member with a blacklisted role will not be able to gain currency from messages.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2FJK4bZTZuDZeyjMzu4zWw%2FScreen_Shot_2022-09-15_at_4.46.17_PM.png?alt=media&#x26;token=3961896e-eafa-476c-9700-430085606e33" alt=""><figcaption></figcaption></figure>

## Reactions

This feature will reward members with currency for reacting to messages. You can even configure what emojis or messages are eligible for currency.

**Currency Per Reaction:** The amount of currency that is given for every eligible reaction.

**Time Interval:** The minimum amount of time (in seconds) between reactions.

**Whitelisted Categories:** Only reactions in these categories will earn currency.

**Blacklisted Categories:** Reactions in these categories will not earn currency.

**Whitelisted Channels:** Only reactions sent in these channels will be eligible for currency.

**Blacklisted Channels:** No reactions sent in these channels will be eligible for currency.

**Whitelisted Reactions:** Only these reactions are eligible for currency. When entering emojis you can use Unicode or the Discord format (🔥 or :fire:). Custom emojis also work.

**Whitelisted Message IDs:** Any message IDs posted here will override blacklisted channels. You can either paste the message ID or the message link. Separate each ID with a comma.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2Ff32sVLUhvgP4uOmbbvfR%2FScreen_Shot_2022-09-15_at_4.57.52_PM.png?alt=media&#x26;token=21ceab22-b829-40d4-ae7f-fde840cadab2" alt=""><figcaption></figcaption></figure>

## Earnable Roles

These are roles that can be earned once a member reaches a certain currency threshold. Setup will require you to select a role and enter an amount of currency that a member will need to gain for that role. Currency is not deducted from the member after reaching the threshold, think of this as an achievement.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2Fpq7THxbUsyAEhjSDgWcC%2FScreen_Shot_2022-09-12_at_11.52.54_AM.png?alt=media&#x26;token=003b160f-94ad-4d32-bd25-8d39015db327" alt=""><figcaption></figcaption></figure>

## Rewarded Roles

These are roles that will reward members with a certain amount of currency for a set time period. This is a great way to reward NFT holders, customers, server boosters, or any other supporters.

1. Press “Add Rewarded Role” and select a role.
2. After this, you will be prompted with a panel to enter the currency amount and time interval.
3. The final step is to set the role as recurring or not recurring. A recurring reward role will gradually give out the currency over the time period, while a non-recurring reward role will only give out the currency after the time period.

Recurring reward roles will automatically give members a fraction of the currency approximately once an hour.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2FthEAT5cQJ4xPg8MdT1zB%2FScreen_Shot_2022-09-12_at_11.53.59_AM.png?alt=media&#x26;token=410d250a-4748-42ce-91b4-b3de60db2ded" alt=""><figcaption></figcaption></figure>

## Username Keywords

Members with a specific keyword in their username will receive currency over a set time period.

**Add Username Keyword:** This is the keyword that will allow a member to gain currency. It is not case sensitive and can be more than 1 word long.

**Currency Per Interval:** The amount of currency to be given out every time interval.

**Time Interval:** How often to reward currency.

**Set Recurring:** Choose if currency should be given out slowly over the course of the time interval (recurring), or if currency should only be given out after the time interval is over (not recurring).

**Whitelisted Roles:** Only members with these roles can gain currency from their username.

**Blacklisted Roles:** Any member with a blacklisted role will not be able to gain currency from their username.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2Ftj2KhnCFhreY5n21Udqk%2FScreen_Shot_2022-09-12_at_11.56.53_AM.png?alt=media&#x26;token=536a9d55-ec06-49f8-9908-6229a1560dbb" alt=""><figcaption></figcaption></figure>

A member with the username “whop | Henry” would receive 350 currency after a week.

This will automatically give members a fraction of the currency approximately once an hour if set to recurring.

The keyword must be present in a member’s Discord username, not their server nickname.

## Custom Status Keywords

Members with a specific keyword(s) in their custom status will receive currency over a set time period.

**Custom Status Keyword(s):** The keyword(s) that will allow a member to gain currency. It is not case sensitive and can be more than 1 word long.

**Set Match Type:** Decide if a custom status should exactly match the keyword(s), or if the status should just contain the keyword(s). Keywords are not case sensitive.

**Currency Per Interval:** The amount of currency to be given out every time interval.

**Time Interval:** How often to reward currency.

**Set Recurring:** Choose if currency should be given out slowly over the course of the time interval (recurring), or if currency should only be given out after the time interval is over (not recurring).

**Whitelisted Roles:** Only members with these roles can gain currency from their custom status.

**Blacklisted Roles:** Any member with a blacklisted role will not be able to gain currency from their custom status.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2F0MkeIQXJWLLGT93anKdv%2FScreen_Shot_2022-09-12_at_11.59.13_AM.png?alt=media&#x26;token=f1ba8843-1181-4da5-a6f7-938e148a5aa0" alt=""><figcaption></figcaption></figure>

A member with the custom status “I love whop” would receive 1500 currency every week.

This will automatically give members a fraction of the currency amount approximately once an hour if set to recurring.

## Following Twitter Account

Members will receive currency over a set time period for following a specific Twitter account.

**Twitter Account**: The username of the Twitter account. The @ symbol is optional and the username is not case sensitive. If the username on Twitter updates, the configured username will need to be updated as well.

**Currency Per Interval:** The amount of currency to be given out every time interval.

**Time Interval:** How often to reward currency.

**Whitelisted Roles:** Only members with these roles can gain currency from following a Twitter account.

**Blacklisted Roles:** Any member with a blacklisted role will not be able to gain currency from following a Twitter account.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2F87aDuNuAAr1ti8cboYuC%2FScreen_Shot_2022-09-12_at_12.01.09_PM.png?alt=media&#x26;token=d84c1745-b453-400e-a134-d2a5f1dc690c" alt=""><figcaption></figcaption></figure>

It may take several hours for members to start gaining currency from following a Twitter account.

## Tweet Keyword

Members will receive currency for using a specific keyword/phrase on Twitter.

**Keyword:** The keyword or phrase that must be present in a member’s Tweet in order to receive currency. If you want members to earn currency for tagging or mentioning an account put an @ symbol in front of the account. Keywords are not case sensitive.

**Currency Amount:** The amount of currency rewarded for using the keyword in a Tweet.

**Whitelisted Roles:** Only members with these roles can gain currency for using a keyword.

**Blacklisted Roles:** Any member with a blacklisted role will not be able to gain currency for using a keyword.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2FABONVqS2fqTQWDkThAHc%2FScreen_Shot_2022-09-12_at_12.03.27_PM.png?alt=media&#x26;token=afdfdcea-22ad-4b96-9414-22ebd06fb67b" alt=""><figcaption></figcaption></figure>

Members should receive currency for using a keyword within an hour.

## Tweet Engagement

Members will receive currency for engaging with a Tweet in a specific way.

**Add Tweet:** You first be prompted to enter a Tweet ID or URL that members must engage with. Then you will enter how much currency members receive for engaging. Finally, you will select the actions members must take to earn currency. Members must complete *every* selected action in order to receive currency.

**Delete Tweets:** Selected Tweets will be removed from the configuration and members will no longer be able to receive currency from them.

**Whitelisted Roles:** Only members with these roles can gain currency from engaging with a Tweet.

**Blacklisted Roles:** Any member with a blacklisted role will not be able to gain currency from engaging with a Tweet.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2F1ZspUL0KPNPBZU3lbL1r%2FScreen_Shot_2022-09-12_at_12.05.26_PM.png?alt=media&#x26;token=904a323f-a807-4ff6-ac36-dc2ede2dfb79" alt=""><figcaption></figcaption></figure>

Depending on the selected actions, members should receive currency for engaging with a Tweet within an hour.

## Antibot

The currency bot has a built-in antibot feature that will prevent members using chatbots from earning currency. This is not a moderation tool and will not delete messages or kick/ban users.

Antibot works by checking the similarity in past messages. Since chatbots usually rotate through several of the same messages, this is a fairly effective way to prevent chatbots from earning currency. The different settings allow for different thresholds of similar messages.

To select the antibot setting type `/antibot`. You will be given 4 different options to choose from. This command requires administrator permission.

**Disabled** This will disable antibot.

**Low** Minimal antibot settings. This is recommended if your community is private.

**Normal** The default setting. This is recommended for most communities.

**Extreme** The most hardcore setting. This is recommended if you have an extremely active community, have a lot of chatbots, or if the normal setting is not strong enough.

## Additional Commands

`/log` will show your past 50 currency events. The optional `member` parameter is limited to admins.

`/profile` will show your current amount of currency, messages sent, and daily passive currency. The optional `member` parameter is limited to admins.

`/leaderboard` will display the top 10 members in the server by currency. This panel can be filtered by All Time, Year, Month, Week, and Day.

`/twitter` will connect your Twitter account through Whop. You must have a Whop account with your Discord and Twitter account linked. This command must be performed in every server where you wish to earn currency from Twitter.

<figure><img src="https://3728436182-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB87vkJ3KTzhJeAmcxU9D%2Fuploads%2FIH81Q3Yafafue2weDE7P%2FScreen_Shot_2022-09-16_at_9.15.42_AM.png?alt=media&#x26;token=2d496071-4b38-4223-8127-dcdcacaa4460" alt=""><figcaption></figcaption></figure>

## Example Settings

While the bot can be configured any way you choose, these settings act as a guide while deciding how to balance your rewards. Some settings are server specific, such as WL/BL channels or earnable roles, and are not included in this example.

**Chat**

* Currency Per Message: 15
* Time Interval: 30 Seconds
* Message Interval: 0 Messages

**Reactions**

* Currency Per Reaction: 3
* Time Interval: 5 seconds

**Username Keywords**

* Username keywords should be something short and non-invasive that members can easily add to their username.
* Currency Per Interval: 40
* Time Interval: 1 Day
* Recurring: Yes

**Custom Status Keywords**

* Custom status keywords can be up to 128 characters long, but Discord will only display about 30 characters under a member's name on the sidebar. Keep this in mind while creating a keyword so it does not get cut off.
* Match Type: Contains
* Currency Per Interval: 30
* Time Interval: 1 Day
* Recurring: Yes

**Following Twitter Account**

* Twitter account should be your Twitter username.
* Currency Per Interval: 25
* Time Interval: 1 Day

**Tweet Keywords**

* The currency amount is dependent on the keyword that members must use. The recommended amount ranges from 30-100.

**Tweet Engagement**

* Currency for engaging is dependent on the actions members must perform. The recommended amount ranges from 25-150.
