Skip to content

A Discord bot for activity handling over a period of time.

License

Notifications You must be signed in to change notification settings

Voxel-Fox-Ltd/Cerberus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cerberus

Cerberus is a small-time activity bot that handles roles based on activity over time rather than all-time activity. This means that users gain and lose activity roles, instead of the common activity bots you get now where people can be active for one week 7 months ago and now they're just hangin' out with the highest activity role.

Where do points come from?

Much like other levelling bots, Cerberus counts one message every minute. Each counted message gives you one point (seen with the /points command), which goes to your weekly max. Unlike most other levelling bots, Cerberus also tracks VC activity, giving a user 1/5th of a point for every minute they're in a VC (assuming they're unmuted, undeafened, not alone, and not in an AFK channel).

Points are calculated as an N-day rolling sum, so if you're especially active on one Monday, that won't stand forever. Those points will all go away.

How many points do I have?

Because of the inherent nature of constantly gaining and losing points, Cerberus wouldn't work well with a "levels" system. What it does show you, however, is your weekly activity over time.

Cerberus has the /graph command, which lets you see your weekly activity.

For this particular graph, each point on the graph is the sum of the user's activity on that particular day, and the colours in the background are the colours of the role the user achieves at that level of acitivity.

How do I use it?

There's only a few commands that are important to Cerberus, but after that it's just plug and play.

  • /setup
    • Takes you through setting up the bot. Here you can set whether users lose old roles on ranking up, which roles users can gain, and channels/roles that are blacklisted from gaining points.
  • /points @User
    • Shows you how many points the given user has gotten.
  • /graph @User
    • Shows you the activity graph of a given user.
  • /roles
    • Shows you which roles you'll get at each level of activity.

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •