DsConfiguration - NobelD/NobleWhitelist GitHub Wiki

Discord:

  • Bot Token:

    • The discord bot token to use.
  • Server ID:

    • The server id where the bot will be used.

Channel:

  • All the channels which will be used for the bot.
  • The channel's id can be changed without reloading.
  • But if you add or remove channels you will need to restart the bot.

Special:

  • Admin Only for Server Management:

    • Makes the admin commands only be visible for discord users which has the server management permission.
    • Even if disabled the users cannot execute these commands without the necessary permissions.
  • Give role on register:

    • Gives the whitelist and sub whitelisted roles to the user when registered.
  • Remove role on unregister:

    • Removes the whitelist and sub whitelisted roles for the user when unregistered.

Role:

  • Enable everyone role:

    • You can add everyone as a role for the commands so everyone can use it without a role.
  • User:

    • Role's id for the simple user.
  • Staff:

    • Role's id for the staff users.
  • Admin:

    • Role's id for the admin users.
  • Whitelisted:

    • The main role to be given to the user, also is used to check if the player has the whitelist role.
  • Sub whitelisted:

    • Extra roles to be added with the whitelisted role.

Announce Channel:

  • Start:

    • The channel where the bot will announce when the server has started.
  • Stop:

    • The channel where the bot will announce when the server has been closed.
  • Notify Self Register:

    • The channel where the bot will announce when a player has registered itself.
  • Notify Self Remove:

    • The channel where the bot will announce when a player has removed itself.
  • Notify Whitelist Auto:

    • The channel where the bot will announce when a player has been auto registered.
    • Activable on the Noble Whitelist config.
  • Notify Whitelist Join:

    • The channel where the bot will announce when a player joins the server and pass the whitelist.
  • Notify Whitelist Try:

    • The channel where the bot will announce when a player tries to join the server but the whitelist denied it.

Commands:

  • Role:

    • Roles who can use this commands.
  • Channels:

    • Channels where this command can be executed.

Default Config

discord:
  bot-token: ""
  server-id: ""
channel:
  primary: 0000000000000000000
  staff: 0000000000000000000
special:
  admin-only-server-manage: true
  give-role-on-register: false
  remove-role-on-unregister: false
role:
  enable-everyone-role: false
  user:
    - 0000000000000000000
    - 0000000000000000000
  staff:
    - 0000000000000000000
  admin:
    - 0000000000000000000
    - 0000000000000000000
  whitelisted: 0000000000000000000
  sub-whitelisted:
    - 0000000000000000000
announce-channel:
  start: none
  stop: none
  notify-self-register: staff
  notify-self-remove: staff
  notify-wl-auto: none
  notify-wl-join: none
  notify-wl-try: none
command:
  basic-add-self:
    role:
      - user
      - staff
      - admin
    channel:
      - primary
      - staff
  basic-remove-self:
    role:
      - user
      - staff
      - admin
    channel:
      - primary
      - staff
  basic-link-self:
    role:
      - admin
    channel:
      - staff
  basic-self-accounts:
    role:
      - user
      - staff
      - admin
    channel:
      - primary
      - staff
  admin-add:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-remove:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-on:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-off:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-perm-status:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-perm-set:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-checking-status:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-checking-set:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-list:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-find:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-find-user:
    role:
      - staff
      - admin
    channel:
      - staff
  admin-user-link:
    role:
      - admin
    channel:
      - staff
  admin-user-unlink:
    role:
      - admin
    channel:
      - staff
  admin-user-toggle:
    role:
      - staff
      - admin
    channel:
      - staff