Join plugin

The join plugin provides configurable options to give your users a role when they join!

When security is enabled in configuration, Speedboat will wait X minutes before the user gains their role. To view the defaults and learn how to configurate them, continue reading.

Configuration Options

OptionDescriptionTypeDefault
join_roleRole ID that is set for users when they meet the critera.idnone
securityWhether the servers security settings influence how long it takes a user to gain their join_role.booltrue
advancedA mapping of verification levels to Advanced Configurationsdictempty

Advanced Configurations

OptionDescriptionTypeDefault
lowTime in minutes until a user gains their join_role for servers with low verification.int0
mediumTime in minutes until a user gains their join_role for servers with medium verification.int5
highTime in minutes until a user gains their join_role for servers with high verification.int10
highestTime in minutes until a user gains their join_role for servers with extreme/highest verification.int30

Configuration Example

join:
  join_role: 814574906044973087
  security: false
  advanced:
    low: 0
    medium: 5
    high: 10
    highest: 30