Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 1.57 KB

README.md

File metadata and controls

30 lines (26 loc) · 1.57 KB
Raw

Access Bot

This is a bot specifically designed for the purpose of handling Discord access requests for vAMSYS virtual airlines.

Configuration

To configure this bot, a config file needs to be renamed in the config directory:

config.json

{
  "airlineID": "", // prefix for pilot ID usernames in the server
  "vamsysKey": "", // 'abcdefgh-ijkl-mnop-qrst-uvwxyz012345'
  "discordToken": "", // Discord bot token
  "servers": {
    "012345678901234567": { // set to the guild ID
      "accessRoleId": ["012345678901234567"], // ID for the role that should be assigned to users that have requested access - comma separate roles for multiple roles to be assigned (eg. ["012345678901234567", "765432109876543210"])
      "nickSeparator": " - ", // the separator that should be used between the name and pilot ID in nicknames
      "roleRemoval": { // section for configuration of the removal of role(s) when a pilot joins a server
        "enabled": true, // set this to true if a role needs to be removed when a user is given access to the server, and false if not
        "roleId": ["012345678901234567"] // if role removal is enabled above, set this to the ID of the role(s) that need to be removed when a user is given access; comma separate roles for multiple roles to be removed (eg. ["012345678901234567", "765432109876543210"])
      }
    }
  }
}

Installation

To install all dependencies required by the bot, run the Dockerfile.

Need help?

This bot was created for the use of vVolotea, a virtual airline hosted on vAMSYS that simulates the real world operations of Volotea.