Skip to content

a rewards system for challenge based competitions in discord servers

License

Notifications You must be signed in to change notification settings

salahmak/reward-system-discord-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Discord Challenge Based Reward System Bot


Getting started

Installation:

git clone https://github.com/salahmak/reward-system-discord-bot
cd reward-system-discord-bot
yarn #or npm install, to install dependencies

Setup:

Before you start the bot, make sure to create a ".env" file and write the required tokens and keys for the bot to work

cp .env.example .env #to create a template .env file that you'll have to fill yourself

Requirments:

  • Discord bot token (make sure to enable all Intents).
  • Mongodb database
  • Prefix: set it in the .env file

Commands

Name Type Description Usage Aliases
help guild shows helpful information about all available commands
  • <pfx> help: Shows name and description of all commands in a single large embed.

  • <pfx> help <command>: Shows name, description, usage and aliases of a specific command.
h
ping guild prints the response latency from the server <pfx> ping N/A
award ranking used to grant users awards when completing a challenge
  • <pfx> award @user1 @user2 ... @userN <amount:uint>: Gives the mentioned users the specified amount of points.

  • <pfx> award @user1 @user2 ... @userN <challengeName:string>: Gives the mentioned users the amount of points that the specified challenge awards.
reward
remove ranking used to remove awards from users
  • <pfx> remove @user1 @user2 ... @userN <amount:uint>: takes back from the mentioned users the specified amount of points.

  • <pfx> remove @user1 @user2 ... @userN <challengeName:string>: takes back from the mentioned users the amount of points that the specified challenge had awarded them.
rm
profile ranking Shows the score and number of solved challenges of a user
  • <pfx> profile: Shows the statistics of the user who issued the command.

  • <pfx> profile @user <challengeName:string>: Shows the statistics of @user
p
leaderboard ranking Shows top 10 users sorted by amount of points
  • <pfx> leaderboard

lb
challenges challenges Allows adding, removing, editing and listing challenges
  • <pfx> challenges add <challengeName:string> <award:uint>

  • <pfx> challenges edit <challengeName:string> <newAward:uint>

  • <pfx> challenges remove <challengeName:string>

  • <pfx> challenges list

ch, challenge

About

a rewards system for challenge based competitions in discord servers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages