discordsrv / documentation

DiscordSRV documentation

A Minecraft to Discord and back link plugin

Thanks to:

The Java IDE for Professional Developers by JetBrains

JProfiler's intuitive UI helps you resolve performance bottlenecks, pin down memory leaks and understand threading issues.

documentation's Issues

Plugin list request for using API

Request for NeoPerformance, https://www.spigotmc.org/resources/neoperformance.103183/, to be listed as plugin using discordsrv api

Document `.token` file and env variables

Code: DiscordSRV.java#L809-L828

Specify `discordsrv.nicknamesync` permission on synchronization page

Should also be included in the NicknameSynchronization section of the synchronization.yml config

Spamming console with odd error

when someone joined the server i saw part of the cause of the spam with the follow error

Caused by: github.scarsz.discordsrv.dependencies.jda.api.exceptions.ErrorResponseException: 10008: Unknown Message

wikipage for converting database with linked accounts

Hello, I think it would be great if there was a page dedicated to converting linked account databases between different formats.

Here is a simple python script that converts the SQL database exported from phpMyAdmin into JSON format used by DiscordSRV by default:

script

#!/usr/bin/env python3
import os

# this script converts DiscordSRV database exported from phpMyAdmin in .sql to .json
# place your .sql database for conversion into the same directory as this script

# this changes the current working directory to the directory of this script
os.chdir(os.path.dirname(__file__))
working_directory = os.getcwd()

# please rename "DatabaseName" to the name of the database that you want to convert:
database = "DatabaseName.sql"

with open(database) as f:
  contents = f.read()
  lines = contents.split("INSERT INTO `discordsrv_accounts` (`link`, `discord`, `uuid`) VALUES")[1].split(";")[0].split(")")
  lines.pop()
  
  json = {}
  for i in lines:
      discordId = i.split(", '")[1].split("'")[0]
      uuid = i.split("', '")[1].split("'")[0]
      json[discordId] = uuid
  
  with open("linkedaccounts.json", "w") as output:
      output.write(str(json).replace("'", '"'))

print("done, file saved to: " + working_directory)

There used to be ip protection. Where is she now?

Previously, every time the plugin logged in, it checked the ip and if it changed, it asked the user to confirm the account using Discord by sending the code to the bot's private messages. Where is this feature now?

Note down limitations of role sync on installation page

This should include things like the bot needing to have a higher role, not modifying the owner etc etc

Update installation page to show a list of features and links to set them up

Currently, the installation page only shows how to set up a couple of the plugin's features and doesn't make it completely clear that these are optional. It would be nice if we could have a bulleted list of the different features that the plugin has and then links to separate pages on configuring each individual one.

Plugins that use API

https://modrinth.com/plugin/slashadditions
https://www.spigotmc.org/resources/custom-bans-plus-fully-customizable-ban-manager.89075/

Outdated alerts.yml example

It seems like the Sign placement alerts.yml example is now outdated due to it trying to access theLines.

SignChangeEvent

Document `DiscordGameStatus` placeholder

%online% - PresenceUpdater.java#L77

Needs to be documented in config.yml as well