AuthMe/AuthMeReloaded

View on GitHub
src/main/resources/plugin.yml

Summary

Maintainability
Test Coverage
# noinspection YAMLSchemaValidation
name: ${pluginDescription.name}
# noinspection YAMLSchemaValidation
authors: [${pluginDescription.authors}]
website: ${project.url}
description: ${project.description}
# noinspection YAMLSchemaValidation
main: ${pluginDescription.main}
version: ${pluginDescription.version}
api-version: 1.16
softdepend:
    - Vault
    - LuckPerms
    - PermissionsEx
    - bPermissions
    - zPermissions
    - Multiverse-Core
    - Essentials
    - EssentialsSpawn
    - ProtocolLib
libraries:
  - ch.jalu:injector:${dependencies.injector.version}
  - net.ricecode:string-similarity:${dependencies.string-similarity.version}
  - com.maxmind.geoip2:geoip2:${dependencies.geoip2.version}
  - javatar:javatar:${dependencies.javatar.version}
  - org.apache.commons:commons-email:${dependencies.commons-email.version}
  - com.zaxxer:HikariCP:${dependencies.hikaricp.version}
  - org.slf4j:slf4j-simple:${dependencies.slf4j.version}
  - ch.jalu:datasourcecolumns:${dependencies.datasourcecolumns.version}
  - com.mysql:mysql-connector-j:${dependencies.mysql-connector-j.version}
  - org.mariadb.jdbc:mariadb-java-client:${dependencies.mariadb-java-client.version}
  - org.postgresql:postgresql:${dependencies.postgresql.version}
  - de.rtner:PBKDF2:${dependencies.pbkdf2.version}
  - de.mkammerer:argon2-jvm-nolibs:${dependencies.argon2-jvm-nolibs.version}
  - at.favre.lib:bcrypt:${dependencies.bcrypt.version}
  - com.warrenstrange:googleauth:${dependencies.googleauth.version}
  - ch.jalu:configme:${dependencies.configme.version}
  - org.bstats:bstats-bukkit:${dependencies.bstats.version}
commands:
  authme:
    description: AuthMe op commands
    usage: /authme register|unregister|forcelogin|password|lastlogin|accounts|email|setemail|getip|totp|disabletotp|spawn|setspawn|firstspawn|setfirstspawn|purge|purgeplayer|backup|resetpos|purgebannedplayers|switchantibot|reload|version|converter|messages|recent|debug
  email:
    description: Add email or recover password
    usage: /email show|add|change|recover|code|setpassword
  login:
    description: Login command
    usage: /login <password>
    aliases:
    - l
    - log
  logout:
    description: Logout command
    usage: /logout
  register:
    description: Register an account
    usage: /register [password] [verifyPassword]
    aliases:
    - reg
  unregister:
    description: Unregister an account
    usage: /unregister <password>
    aliases:
    - unreg
  changepassword:
    description: Change password of an account
    usage: /changepassword <oldPassword> <newPassword>
    aliases:
    - changepass
    - cp
  totp:
    description: TOTP commands
    usage: /totp code|add|confirm|remove
    aliases:
    - 2fa
  captcha:
    description: Captcha command
    usage: /captcha <captcha>
  verification:
    description: Verification command
    usage: /verification <code>
permissions:
  authme.admin.*:
    description: Gives access to all admin commands
    children:
      authme.admin.accounts: true
      authme.admin.antibotmessages: true
      authme.admin.backup: true
      authme.admin.changemail: true
      authme.admin.changepassword: true
      authme.admin.converter: true
      authme.admin.firstspawn: true
      authme.admin.forcelogin: true
      authme.admin.getemail: true
      authme.admin.getip: true
      authme.admin.lastlogin: true
      authme.admin.purge: true
      authme.admin.purgebannedplayers: true
      authme.admin.purgelastpos: true
      authme.admin.purgeplayer: true
      authme.admin.register: true
      authme.admin.reload: true
      authme.admin.seeotheraccounts: true
      authme.admin.seerecent: true
      authme.admin.setfirstspawn: true
      authme.admin.setspawn: true
      authme.admin.spawn: true
      authme.admin.switchantibot: true
      authme.admin.totpdisable: true
      authme.admin.totpviewstatus: true
      authme.admin.unregister: true
      authme.admin.updatemessages: true
  authme.admin.accounts:
    description: Administrator command to see all accounts associated with a user.
    default: op
  authme.admin.antibotmessages:
    description: Permission to see Antibot messages.
    default: op
  authme.admin.backup:
    description: Allows to use the backup command.
    default: op
  authme.admin.changemail:
    description: Administrator command to set or change the email address of a user.
    default: op
  authme.admin.changepassword:
    description: Administrator command to change the password of a user.
    default: op
  authme.admin.converter:
    description: Administrator command to convert old or other data to AuthMe data.
    default: op
  authme.admin.firstspawn:
    description: Administrator command to teleport to the first AuthMe spawn.
    default: op
  authme.admin.forcelogin:
    description: Administrator command to force-login an existing user.
    default: op
  authme.admin.getemail:
    description: Administrator command to get the email address of a user, if set.
    default: op
  authme.admin.getip:
    description: Administrator command to get the last known IP of a user.
    default: op
  authme.admin.lastlogin:
    description: Administrator command to see the last login date and time of a user.
    default: op
  authme.admin.purge:
    description: Administrator command to purge old user data.
    default: op
  authme.admin.purgebannedplayers:
    description: Administrator command to purge all data associated with banned players.
    default: op
  authme.admin.purgelastpos:
    description: Administrator command to purge the last position of a user.
    default: op
  authme.admin.purgeplayer:
    description: Administrator command to purge a given player.
    default: op
  authme.admin.register:
    description: Administrator command to register a new user.
    default: op
  authme.admin.reload:
    description: Administrator command to reload the plugin configuration.
    default: op
  authme.admin.seeotheraccounts:
    description: Permission to see the other accounts of the players that log in.
    default: op
  authme.admin.seerecent:
    description: Administrator command to see the last recently logged in players.
    default: op
  authme.admin.setfirstspawn:
    description: Administrator command to set the first AuthMe spawn.
    default: op
  authme.admin.setspawn:
    description: Administrator command to set the AuthMe spawn.
    default: op
  authme.admin.spawn:
    description: Administrator command to teleport to the AuthMe spawn.
    default: op
  authme.admin.switchantibot:
    description: Administrator command to toggle the AntiBot protection status.
    default: op
  authme.admin.totpdisable:
    description: Administrator command to disable the two-factor auth of a user.
    default: op
  authme.admin.totpviewstatus:
    description: Administrator command to see whether a player has enabled two-factor
      authentication.
    default: op
  authme.admin.unregister:
    description: Administrator command to unregister an existing user.
    default: op
  authme.admin.updatemessages:
    description: Permission to use the update messages command.
    default: op
  authme.allowchatbeforelogin:
    description: Permission to send chat messages before being logged in.
    default: false
  authme.allowmultipleaccounts:
    description: Permission to be able to register multiple accounts.
    default: op
  authme.bypassbungeesend:
    description: Permission node to bypass BungeeCord server teleportation.
    default: false
  authme.bypassantibot:
    description: Permission node to bypass AntiBot protection.
    default: op
  authme.bypasscountrycheck:
    description: Permission to bypass the GeoIp country code check.
    default: false
  authme.bypassforcesurvival:
    description: Permission for users to bypass force-survival mode.
    default: op
  authme.bypasspurge:
    description: Permission to bypass the purging process.
    default: false
  authme.debug:
    description: Gives access to /authme debug and all its sections
    children:
      authme.debug.command: true
      authme.debug.country: true
      authme.debug.db: true
      authme.debug.group: true
      authme.debug.limbo: true
      authme.debug.mail: true
      authme.debug.mysqldef: true
      authme.debug.perm: true
      authme.debug.spawn: true
      authme.debug.stats: true
      authme.debug.valid: true
  authme.debug.command:
    description: General permission to use the /authme debug command.
    default: op
  authme.debug.country:
    description: Permission to use the country lookup section.
    default: op
  authme.debug.db:
    description: Permission to view data from the database.
    default: op
  authme.debug.group:
    description: Permission to view permission groups.
    default: op
  authme.debug.limbo:
    description: Permission to use the limbo data viewer.
    default: op
  authme.debug.mail:
    description: Permission to use the test email sender.
    default: op
  authme.debug.mysqldef:
    description: Permission to change nullable status of MySQL columns.
    default: op
  authme.debug.perm:
    description: Permission to use the permission checker.
    default: op
  authme.debug.spawn:
    description: Permission to view spawn information.
    default: op
  authme.debug.stats:
    description: Permission to use the stats section.
    default: op
  authme.debug.valid:
    description: Permission to use sample validation.
    default: op
  authme.player.*:
    description: Gives access to all player commands
    children:
      authme.player.canbeforced: true
      authme.player.captcha: true
      authme.player.changepassword: true
      authme.player.email.add: true
      authme.player.email.change: true
      authme.player.email.recover: true
      authme.player.email.see: true
      authme.player.login: true
      authme.player.logout: true
      authme.player.protection.quickcommandsprotection: true
      authme.player.register: true
      authme.player.security.verificationcode: true
      authme.player.seeownaccounts: true
      authme.player.totpadd: true
      authme.player.totpremove: true
      authme.player.unregister: true
  authme.player.canbeforced:
    description: Permission for users a login can be forced to.
    default: true
  authme.player.captcha:
    description: Command permission to use captcha.
    default: true
  authme.player.changepassword:
    description: Command permission to change the password.
    default: true
  authme.player.email:
    description: Gives access to all email commands
    children:
      authme.player.email.add: true
      authme.player.email.change: true
      authme.player.email.recover: true
      authme.player.email.see: true
  authme.player.email.add:
    description: Command permission to add an email address.
    default: true
  authme.player.email.change:
    description: Command permission to change the email address.
    default: true
  authme.player.email.recover:
    description: Command permission to recover an account using its email address.
    default: true
  authme.player.email.see:
    description: Command permission to see the own email address.
    default: true
  authme.player.login:
    description: Command permission to login.
    default: true
  authme.player.logout:
    description: Command permission to logout.
    default: true
  authme.player.protection.quickcommandsprotection:
    description: Permission that enables on join quick commands checks for the player.
    default: true
  authme.player.register:
    description: Command permission to register.
    default: true
  authme.player.security.verificationcode:
    description: Permission to use the email verification codes feature.
    default: true
  authme.player.seeownaccounts:
    description: Permission to use to see own other accounts.
    default: true
  authme.player.totpadd:
    description: Permission to enable two-factor authentication.
    default: true
  authme.player.totpremove:
    description: Permission to disable two-factor authentication.
    default: true
  authme.player.unregister:
    description: Command permission to unregister.
    default: true
  authme.vip:
    description: When the server is full and someone with this permission joins the
      server, someone will be kicked.
    default: false