s3ks1 / discordranksync Goto Github PK

Extremely lightweight plugin to synchronize in-game ranks with Discord roles!

Here's why you should use this plugin:

• Lightweight & Optimized
• Easy setup; Drag & Drop (Set up your discord bot, and you are ready to go!)
• Multiple database options: YAML, MongoDB, MySQL
• Developer API in case you want to implement this in your plugins!
• Extremely and easily configurable

(back to top)

This shows how you install the plugin.

1. Create an application at https://discord.com/developers/applications
2. Create a bot within the application and copy the bot token
3. Click OAuth2 > URL Generator
4. Check applications.commands & bot under Scopes
5. Check whichever permissions your bot will require under Bot Permissions
6. Copy the Generated URL and invite the bot to your discord server
7. Drop this plugin in your ./plugins folder
8. Once the config.yml is created, insert the bot token which you have copied and restart the server
9. Join the server and start linking your account with /discord link!

(back to top)

This is a list of commands available in the plugin and their respective permissions required.

(back to top)

This section is for developers who want to make use of this plugin's API.

package net.evilkingdom.discordranksync.api;

import org.bukkit.OfflinePlayer;

import javax.annotation.Nullable;

public interface DiscordRankSyncAPI {

    /**
     * Returns whether player is linked with a discord user
     *
     * @param player ~ The player to check if its linked
     * @return ~ Returns true if the player is linked with a discord user else false
     */
    boolean isLinked(OfflinePlayer player);

    /**
     * Get the discord ID of a player, if the player is linked
     *
     * @param player ~ The player to query for its discord ID
     * @return ~ Returns the discord ID as a string if the player is linked, else null
     */
    @Nullable
    String getDiscordId(OfflinePlayer player);
}

To get the API implementation:

DiscordRankSyncAPI api =  ((DiscordRankSync) Bukkit.getPluginManager().getPlugin("DiscordRankSync")).getInstance().getApi();

(back to top)

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

TheTrustyPwo - Pwo#0001 - [email protected]

Project Link: https://github.com/EvilKingdom/DiscordRankSync

(back to top)