Skip to content

A Discord Bot written in JavaScript for the official 10FF Discord.

Notifications You must be signed in to change notification settings

wRadion/10FFDiscordBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

10FF Auto-Roles Bot

⚠ Please read:

This bot only gives the WPM, the achievements (Supporter, Translator, Completionist) and the Multilingual role automatically using your 10FF profile page.

If you wish to submit a video to have the Verified ✅ role, don't use the command: send a message with your 10FF profile and a link to the video in the #roles-request channel.

If you want to have the self assignable roles (Qwerty, 10 Fingers, english, ...) go to the #self-assignable-roles channel.

Index

  1. Summary
  2. Request Queue
  3. Identification
  4. Roles
  5. Known Issues
  6. Bugs, issues, suggestions

Summary

Usage:

!roles <your 10FF profile URL>

Example:

!roles https://10fastfingers.com/user/209050/

The command only works in the #auto-roles channel.

Please be patient with the bot. A single request can take up to 10 or 20 seconds. But, if after this time, nothing happened, it's most likely that the bot crashed. See Known Issues for more information.

Request Queue

Because of server limitations, the command works with a queue system. The bot will tell you the position you are in, and it will send a message whenever your request is being processed. If after 1 min your request is not being processed, try to redo the command or send me a message.

Identification

You will need to put your Discord Tag (e.g. Discord#0000) OR Discord ID in your 10FF Profile description so the bot will be able to check that it's your profile.

Don't worry, your Discord ID is not a sensitive data to share. Everyone can have it.

To get your Discord ID, just right-click your name on Discord and click "Copy ID".

CopyID

If the Copy ID button is not present, you will have the enable the Developer Mode (Settings > Appearance > Advanced > Developer Mode).

DeveloperMode

Roles

This bot gives those roles automatically:

  • 10FF Supporter ❤
  • Site Translator ✒
  • Completionist
  • Multilingual ⌨️

Plus WPM and WPM (Advanced) roles.

Plus Tests Taken roles.

Plus Competitions Taken roles.

Roles Removal

The bot can remove a role from you if your profile don't meet the new requirements.

WPM roles

If you're not happy with your WPM roles (if you wish to use your average instead of your max), you can specify your requested roles for normal and advanced:

!roles https://10fastfingers.com/user/209050/ 150 130

Even though I can have the 170-179 WPM and the 140-149 WPM (Advanced) roles with the max detected scores, the command above will give me the 150-159 WPM and 130-139 WPM (Advanced) roles.

Obviously, you can't request a WPM role that is higher that your highest score. The bot only sees your last 400 tests (normal and advanced).

Competitions

For now, the competitions are not read by the bot. But it will (soon?) be possible to specify a competition URL if you did your record there.

Language

If your main language (the language in which you did the most tests) is not the language you wish to use for your WPM roles, you can specify it in the command:

!roles https://10fastfingers.com/user/209050/ english

All languages are supported.

Chinese Traditional & Simplified

For Chinese languages, use chinese_traditional or chinese_simplified as the language name. The WPM are not calculated the same way as other languages. Your speed role won't be the one displayed on your graph, but rather the "Correct Words" value.

Japanese

For Japanese language, the bot will only see the tests you did after the WPM calculation was updated (i.e. after the 25 Feb 2019).

10FF Supporter, Site Translator and Completionist

The bot will check if you have the achievement corresponding to the role.

Multilingual ⌨️

The condition to have the Multilingual ⌨️ role is as follows: you need to have at least 50 tests in 10 languages.

Verified ✅

If you have the Verified ✅ role and your new WPM (normal or advanced) is higher, the bot will automatically remove your Verified ✅ role.

Someone will have to check manually your new speed to (re)add you the role.

Known issues

  • In some cases, the bot says that it added/removed roles, but you still have your old roles. You have to wait a bit, it can take up to 1 minute before having your roles.
  • You can ask a friend to add your Discord tag in his description to have his roles (please don't do that...)

Bugs, issues, suggestions

If you have any problem with the bot please feel free to report the bugs by creating an issue on github or directly to me on Discord (wRadion#5043) or by email me@wradion.dev. You can also find me on the official 10FF Discord.

About

A Discord Bot written in JavaScript for the official 10FF Discord.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published