mexalucard0 / athena-plugin-discord-allow-list

A minimal allow list plugin for Discord Servers

Athena Plugin - Discord Allow List

A plugin for Allow Listing on Discord when Authenticating with the Athena Framework's Discord Login compatible with 5.1.0 of the Athena Framework.

• Ensures a user is in your Discord.
• Ensures a user has an allow list role.

A user who is not in your Discord Server will never be able to join.

Installation

1. Open a command prompt in your main Athena Directory.
2. Navigate to the plugins folder.

cd src/core/plugins

3. Copy one of the commands below.

SSH

git clone [email protected]:Athena-Framework-V5/athena-plugin-discord-allow-list.git

HTTPS

git clone https://github.com/Athena-Framework-V5/athena-plugin-discord-allow-list

1. Navigate into src/core/plugins/athena-plugin-discord-allow-list
2. Open the config.ts file.
3. Fill in the information in the configuration including IDs for roles to allow list.

All the information can be obtained from https://discord.com/developers/applications

• You need to create a bot.
• You need to copy the bot's token and put it into the configuration.
• You need to copy the Discord Guild Identifier. Which can be obtained in developer mode on Discord. Google it.
• Turn off public bot, Turn on SERVER MEMBERS INTENT and PRESENCE INTENT in the bot settings.
• Ensure the bot is in your Discord Server
• Ensure the bot can see all users

7. Start the server, watch for any warnings.
8. If no warnings then the plugin was configured successfully.

API Usage

This plugin comes with a small API with some general functions.

• getMember(discord: string)
• enableAllowList(shouldEnable: boolean)

async function doSomething() {
    const allowListApi = await Athena.systems.plugins.useAPI('discord-allow-list');
    if (typeof allowListApi === 'undefined') {
        return;
    }

    // Allow anyone to join the server.
    allowListApi.enableAllowList(false);

    // Used to obtain a guild member, returns undefined if not in your discord server.
    const guildMember = await allowListApi.getMember('202685967935471617');
    console.log(guildMember);
}