Skip to content

RowwYourBoat/LifeSeriesIntegration

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Discord Integration

Discord Integration Guide

Can't get it to work? Feel free to ask for help in my Discord Support Server!

  1. Invite the bot to your Discord Server
    Click here to be prompted to do so, and select the server to which you want to add the bot.
    Follow the rest of the invitation process until the bot has joined your Discord Server.

  2. Customize the newly added roles
    Upon joining your server, the bot will immediately create 5 coloured roles. You may change these to your heart's content (name, position, permissions, etc.) – just don't delete them.

  3. Set the Server ID in the plugin's configuration file to your own
    To get this ID, you will first need to enable Developer Mode in your Discord settings.
    Open your Discord Settings, and navigate to the Advanced page which may be found under the App Settings tab.
    Enable Developer Mode, exit out of your settings, and right-click your Discord Server's icon on the left.
    A new button should've appeared, appropriately named "Copy Server ID". Click that to copy your Server ID.

    Now that you've retrieved your Server ID, navigate to the plugin's config.yml file. (server\plugins\LimitedLife\config.yml)
    Scroll down until you stumble across the discord-integration section. Here, you must set the server-id value to the Server ID you copied earlier. Also make sure to set the enabled value to true.

  4. Link your Discord profile to your Minecraft account
    Run the command /link username:YOUR_MINECRAFT_USERNAME in your Discord server. This will give you the green coloured role, which will be updated (if necessary) next time you start the timer within your Minecraft Server.

  5. Test whether it's working
    Start your Minecraft Server as well as the plugin's timer. Now you may simply use the /lf modifytime command until the colour of your name changes (Example: /lf modifytime PLAYER -10h). If your role doesn't get updated, please check the server's console for any error messages. Can't get it to work? Join my Discord Support Server!

Command Documentation

The bot features a total of eight commands, two of which only accessible to members with the Time out members permission and one to members with the Administrator permission.

  • /link username
    Links the executor's Discord ID to the specified Minecraft Account's UUID.

  • /unlink
    Unlinks the executor from their linked Minecraft Account's UUID.

  • /ping
    The bot will respond with "Pong!".

  • /get_member username
    Returns the Discord account with which the specified Minecraft username is currently linked.

  • /get_username member
    Returns the Minecraft account with which the specified Server Member is currently linked.

  • /admin link member username (Moderate Members Permission Required)
    Links the specified Server Member with the specified Minecraft Account's UUID.

  • /admin unlink member (Moderate Members Permission Required)
    Unlinks the specified member from their linked Minecraft Account's UUID.

  • /purge reform? (Administrator Permission Required)
    Completely wipes all data related to your Discord Server from the bot's database, and deletes all roles created by the bot.
    Want the bot to set itself up from scratch again? Pass in true for the reform argument. Pass in false if you don't want this.

Troubleshooting

UNAUTHORIZED
Run the /purge reform:true command within your Discord Server and try again.

BAD GATEWAY
This is an error outside of my and your control, as it's related to Discord's API. You'll simply have to wait for it to be resolved on their end.

NOT FOUND
If you get an error stating that you most likely haven't added the integration bot to your server, run the /purge reform:true command. The bot most likely failed to setup properly upon joining your server. Another option is the bot being unable to find the requested UUID within its database. This means that the player to which that UUID belongs didn't /link their account.

Something went wrong while trying to communicate with the integration bot
Make sure that you haven't edited the endpoint configuration value inside of your config.yml file. If restoring that didn't fix the issue, it most likely means that the bot is currently offline. Please let me know via Discord so that I can fix the issue.

Discord Integration is set to enabled, but has not been set up correctly
This means that you haven't set the Guild ID to your own within the config.yml file.