Difference between revisions of "CommunityBot"
m (→Outreach: link up)
|Line 221:||Line 221:|
== Technical ==
== Technical ==
=== Installation ===
=== Installation ===
Revision as of 13:06, 2 October 2017
Communitybot is an automated chat bot for use in the Waze Discord servers.
- 1 Features
- 2 Commands
- 2.1 Glossary
- 2.2 Lookup
- 2.3 Outreach
- 2.4 Tiles
- 2.5 Profile
- 2.6 Autoreplies
- 2.7 Keyword Subscriptions
- 2.7.1 Notes
- 2.7.2 Base command
- 2.7.3 Regular Expressions
- 2.7.4 List keywords
- 2.7.5 Add a keyword
- 2.7.6 Test a keyword
- 2.7.7 Remove a keyword
- 2.7.8 Ignoring keywords in servers or channels
- 2.7.9 Mute servers or channels
- 2.8 Scripts
- 2.9 Server Leave Alerts
- 2.10 Fun
- 3 Getting IDs
- 4 Technical
Communitybot can sync your roles across the regional Discord servers. A limited number of roles are set by the bot for security reasons; others must be set manually and are not synced automatically. The table below gives the available roles and the permission required to set them. For example, the L6 role can only be given by champs, and only when the command is used in the national server.
- NOTE: Any command which includes @username in the table below cannot be used on yourself--it must be assigned by someone else with the appropriate permissions.
|Role||Bot Command||Role Required|
|Country Manager (CM)||!cm @username||CM or above|
|State Manager (SM)||!sm @username||SM or above|
|Large Area Manager (LAM)||!lam @username||SM or above|
|Area Manager (AM)||!am @username||SM or above|
|Mentor||!mentor @username||SM or above|
|Region-specific||!region @username||SM or above|
|Level 6 (L6)||!l6 @username||Champ in national server|
|Level 5 (L5)||!l5 @username||SM or above|
|Level 4 (L4)||!l4 @username||SM or above|
|Level 3 (L3)||!l3 @username||SM or above|
|Level 3 (L3)||!l3||Anyone (role is assigned to command user)|
|Level 2 (L2)||!l2 @username||SM or above|
|Level 2 (L2)||!l2||Anyone (role is assigned to command user)|
|Level 1 (L1)||!l1 @username||SM or above|
|Level 1 (L1)||!l1||Anyone (role is assigned to command user)|
You can search for glossary terms with the command
!glossary, using the format
!glossary search term.
Some channels may have a linked Google Spreadsheet. If your channel does, you can search it using
!lookup. An example command is
!lookup search term.
Add/modify a lookup sheet
To add a lookup sheet to a channel use the
!lookup add command and specify the sheet ID. Example: If you have a Google Sheet link like
https://docs.google.com/spreadsheets/u/1/d/1-f-JTWY5UnBx-rFTa4qhyGMYdHBZWNirUTOgn222zMY/pubhtml?gid=1292189415&single=true the sheet ID is
1-f-JTWY5UnBx-rFTa4qhyGMYdHBZWNirUTOgn222zMY. For the bot to be able to search the sheet it must be published to the web.
If multiple tabs are published to the web, you must specify the gid for the sheet you want to run the
!lookup against. You do this when you add the sheet. In the link above, a gid is given (
1292189415). To specify the sheet and tab you would add a space after the sheet ID and add the gid from the URL. Ex:
!lookup add 1-f-JTWY5UnBx-rFTa4qhyGMYdHBZWNirUTOgn222zMY 1292189415.
To change the sheet that is used for the channel, run the
!lookup add command with the new sheet ID and it will be modified.
This is restricted to SM or above.
Remove lookup sheet
To remove a lookup sheet from a channel use the
!lookup remove command.
This is restricted to SM or above.
!outreach command is the same as lookup but dedicated to the use of lookup searches for outreach sheets, due to the number of states/regions that maintain these. This frees up the
!lookup command for other sheet searches.
You can query the last NA and INTL tile update with the command
You can generate profile links for a given editor name with the
!profile command. An example command is
!profile EditorName. This will return the editor profile, forum profile and wiki profile links. The bot will check if the forum and wiki profiles exist and if they do not it will return
No forum profile and
No wiki profile, respectively.
An autoreply is a message that the bot will reply with automatically when a certain phrase is said in chat. Autoreplies can be created at the channel, server, or global levels. The syntax is by nature somewhat convoluted due to the features provided. To trigger an autoreply, the keyword is sent preceded by an exclamation mark
Channel and server autoreplies can be set by SM+, and global autoreplies can be set only in the national server by champs.
The base command is
!autoreplies, by itself this will bring up a list of available autoreplies for the area it is used in. To add or remove autoreplies, send the command from the server, and/or channel you want it to apply to. The command is made of four parts; base + action + area + trigger term + autoreply text.
trigger term = the keyword that when typed will trigger this response. Do not include the preceding exclamation mark.
autoreply text = the full formatted text that should be return when the trigger term sent.
Here's an example command:
!autoreplies add server testing This is a test.
!autoreplies remove global anothertest This is another test.
Below is a list of some of the global autoreplies which have been set.
|!help||Link to this page|
|Information about using external sources and © content|
|!nickname||Instructions to set up a proper nickname on Discord|
|Check if bot is working|
|!source||Link to source code for the bot|
You can subscribe to keywords and the bot will message you whenever one is used in a channel that you're in. The commands are somewhat complicated because of the functionality available.
Keywords must be at least 2 characters long. Regular keywords are not case-sensitive but regex keywords are by default (regex special characters such as
\W are respected) - more below.
The base command to use is
!subscription, or variants of these.
Regular expression keywords are supported. To use them, create a keyword as normal but wrap your regex in
/. For example,
!keyword add /.*/. Regex keyword are case sensitive by default. To make the keyword case insensitive end your regex with
/i instead of
/wAzE/ will match with
wAzE but not
/wAzE/i will match both
Your existing keywords can be listed using
Add a keyword
To add a keyword, use
!keyword add keywordhere. You can use multiple words, but note that you will only be messaged if the entire phrase you use is a match. To add multiple separate keywords, you need to use the command multiple times in individual messages.
Test a keyword
You can test your keywords by using the
!keyword test command. This can be run in a channel or a direct message with CommunityBot. Ex:
!keyword test some text to see if your keyword is triggered. If any of your keywords are triggered by your test text CommunityBot will alert you as to which keywords were triggered. This is a good way to make sure you do not duplicate keywords, and you don't have to wait for someone to respond with a test message.
Remove a keyword
Remove keywords using
!keyword remove keywordhere. The keyword must exactly match one of your existing keywords or the command will fail.
Ignoring keywords in servers or channels
By default, the bot will message you if a keyword matches in any channel that you're in. You can ignore specific keywords in certain servers or channels with these commands. To find the server or channel ID, see the Getting IDs section below.
Ignore a keyword in a server
To ignore a server:
!keyword ignore server serverid keywordhere. For example, you could ignore the keyword "testing" in the national server by using
!keyword ignore server 300471946494214146 testing.
Ignore a keyword in a channel
Ignoring a channel uses the same syntax as ignoring a server, except the word "channel" is used instead of "server":
!keyword ignore channel channelid keywordhere. For example, to ignore the keyword "testing" in the GLR channel on the national server, you would use
!keyword ignore channel 300568375900504074 testing.
Unignore a server or channel
Unignoring a server or channel uses the same syntax as ignoring, but with the word "unignore" instead of "ignore". For example:
!keyword unignore server 300471946494214146 testing.
Mute servers or channels
You can mute all keywords from a given server or channel using these commands.
Mute a server
Mute a server using
!keywords mute server serverid. For example,
!keyword mute server 300471946494214146.
Mute a channel
Mute a channel using
!keyword mute channel channelid. For example,
!keyword mute channel 300568375900504074.
Unmute a server or channel
Unmute a server or channel using the same commands as above, except using
unmute instead of
The WazeDev group is maintaining a list of community scripts to search in order to find the current version, current active developer, install & forum links. This list can be searched by running the
!scripts search term command. To view the scripts sheet run
!scripts If a script is missing from this sheet and you feel it should be added, contact MapOMatic or JustinS83 to get it added.
Server Leave Alerts
To have CommunityBot notify a channel when a user leaves the server use the
!serverleave command. Running
!serverleave without any other parameters will return if the server has a channel designated. Only one channel can be designated per server.
This is restricted to administrators of the server.
To designate a channel to be used for server leave messages use the
!serverleave add command and specify the channel id. Example:
!serverleave add 299563059695976451. You can also directly reference the channel - ex:
!serverleave add #general.
To modify the channel used, run the
!serverleave add command with the new channel number.
To remove the channel designation run the
!serverleave remove in any channel on the server.
Some fun commands to try that are not related to discord/Waze.
!xkcd command to return a random xkcd comic. To search for a specific comic number run
!xkcd comicNumber, ex:
Several bot commands use either channel or server IDs to identify those channels or servers. Getting these IDs is relatively straightforward. Navigate to the channel or server that you want the ID for, and look at the URL of the page. For example, the #michigan channel in the GLR server has this URL:
In all URLs, the first large number is the server ID and the second number is the channel ID. In this example, the server ID is
299563059695976451, and the channel ID is
Alternatively, you can use the command
!whereami and the bot will give you these IDs.
Note that the server and channel IDs may be the same!
- Internal ID:
- Language: C# (pronounced "C-Sharp")
- Runtime Environment: .NET Core
There are detailed installation instructions for CommunityBot.
There are detailed build/run instructions for CommunityBot.