DiscordSRV

DiscordSRV

DiscordSRV

The most powerful, configurable, widely loved, open-source Discord bridge plugin out there.

Player/server statistics

Intended usage

Using this plugin, you are able to give players the ability to chat in-game to chat with players on your Discord server as well as having people on the Discord server be able to chat with people on the server- this is useful for the situation of someone not being at their computer and being able to talk in-game.

As well as that, this plugin also has a remote console feature. You can designate a text channel for the plugin to listen on where messages sent to that channel are run as commands by the server console. You should restrict sending this channel to a developer or high ranking role only. Due to how Discord's permissions work, though, you can have some server roles being able to see the console, yet not being able to send messages in that channel, thus creating a read-only console for trusted staff members.

Both the chat and console link are toggleable through the configuration file. Some, but not all, options can be refreshed with /discord reload, by an op. VanishNoPacket permissions like silent join/quit, fake join/quit and join without announcing are checked when sending player join messages in the chat channel.

Install

It's recommended to go to DiscordSRV's wiki at https://github.com/Scarsz/DiscordSRV/wiki/Installation for picture instructions to install DiscordSRV but you can just follow these steps if you want a straight forward install. If you need help finding the bot token, watch this https://www.youtube.com/watch?v=vMvtdp6xJD8.

  1. Create a new application at https://discordapp.com/developers/applications/me/create
  2. On the application's page, click "Create a Bot User" and confirm
  3. Install the plugin, run & stop the server, then open the configuration file
  4. Paste in the token from the application page to the config
  5. Go to http://scarsz.tech/authorize/ & paste your application's Client ID value to the page
  6. In the config option labeled Channels, input your global chat channel's ID under "global"- you can set more channels up here and their linked channels.
    1. For reference, to obtain a channel ID, go to the cog on the bottom left of Discord, go to the appearance tab, enable developer mode. From there you can right click a guild, channel, user, or role and there will be a "Copy ID" option
  7. Optionally add a console channel's ID in the config
  8. Run through all of the config options, you'll be surprised with how many features this plugin has
  9. Profit

Supported plugins

DiscordSRV implements with a fair amount of plugins for chat and vanish functionality. We recommend VentureChat by Aust1n46 but plugins such as Herochat, VentureChat, Essentials, Premium/Super vanish, VanishNoPacket, and Multiverse all have functionality in DiscordSRV.

Commands/permissions

/discord

All of DiscordSRV's commands can be exposed from /discord. This includes but isn't limited to /discord toggle which toggles sending Discord messages back/forth for you- tell your players about this command!

discordsrv.chat

Allows people to have their chat sent to Discord. Go figure. Given by default, only exists so you can negate this permission from people/groups.

OP

All the admin commands for DiscordSRV require you to be an OP. To see the help, run /discordsrv in-game.

FAQ

How do I fix the error "Unsupported major.minor version 52.0?"

Update the server's Java JRE version to Java 8. <1.8 is unsupported.

I reloaded the plugin/server and now it won't work

DON'T RELOAD THE PLUGIN

When I join/quit my server, a message isn't sent in the chat channel for me. What gives?

You have one of VanishNoPacket's/Essentials' permissions to join/quit silently. To disallow this, give yourself or the group one of the following depending on what you want to allow.

-discordsrv.silentjoin
-discordsrv.silentquit

Donations

First off, thank you from the bottom of my heart for the pizza. If you would like to donate, go to https://www.paypal.me/Scarsz/10. $10 is the suggested amount but you can donate however much you would like- anything is a massive thank you from me. In the note put your Discord username and if you're in DiscordSRV's server you'll be set as a donator and you'll receive some neat perks in the future. If you donated without the note, send me a PM on Discord and I'll manually check it.

Developers

If you want to interface DiscordSRV with your plugin, you can do so by adding the Maven dependency or adding the plugin jar (11+) to your project, extending DiscordSRVListener, then overriding the methods in it. For an example of this, see https://github.com/Scarsz/DiscordSRV-ApiTest. Be sure to add "DiscordSRV" to your plugin's plugin.yml depends or softdepends list.

<repository>
    <id>Scarsz-Jenkins</id>
    <url>http://scarsz.tech:8080/plugin/repository/everything/</url>
</repository>

...

<dependency>
    <groupId>com.scarsz.discordsrv</groupId>
    <artifactId>DiscordSRV</artifactId>
    <version>12.0</version>
    <scope>provided</scope>
</dependency>

Data usage

Data collection

Anything and everything shown at http://mcstats.org/plugin/DiscordSRV/view will be visible to the public with your server included in the statistics. This is only for statistics, no private information of your server is sent. If you don't want your server included in this, specify the config option "MetricsDisabled" and set it to "true" in the config.

Update checking

I have absolutely no clue why you would want to disable this, but if you do, set the "UpdateCheckDisabled" config option to "true".


Comments

  • To post a comment, please or register a new account.
Posts Quoted:
Reply
Clear All Quotes

About This Project

Categories

Members

Recent Files

Bukkit