docs.discordsrv.com Open in urlscan Pro
2606:50c0:8001::153  Public Scan

Form analysis
2 forms found in the DOM

<form class="md-header__option" data-md-component="palette">
  <input aria-hidden="true" class="md-option" data-md-color-accent="blue" data-md-color-media="" data-md-color-primary="light-blue" data-md-color-scheme="slate" id="__palette_1" name="__palette" type="radio">
</form>

Name: search —

<form class="md-search__form" name="search">
  <input aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text">
  <label class="md-search__icon md-icon" for="__search">
    <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
      <path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"></path>
    </svg>
    <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
      <path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"></path>
    </svg>
  </label>
  <nav aria-label="Search" class="md-search__options">
    <button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" title="Clear" type="reset">
      <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
        <path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"></path>
      </svg>
    </button>
  </nav>
</form>

Text Content

Skip to content


DiscordSRV Wiki
master
 * master
 * develop
 * ascension

Home

Type to start searching
Documentation
 * 12
 * 27

DiscordSRV Wiki
Documentation
 * 12
 * 27

 * Home Home
   Table of contents
    * Features
       * Plugins we hook into:
          * Chat
          * Vanish
          * World
      
       * Plugins that use our API:
   
    * Intended usage
    * Bot Permissions
       * Server Permissions
       * Channel Permissions
   
    * Installation
    * Donations
    * Developers
    * Data usage
       * Data collection
   
    * Update checking

 * Frequently Asked Questions
 * Installation
   Installation
    * Initial Setup
    * Sync Setup
    * Voice Setup
    * Link to Join Setup

 * Configs
   Configs
    * alerts.yml
    * config.yml
    * linking.yml
    * messages.yml
    * synchronization.yml
    * voice.yml

 * Commands
 * Permissions
 * Hooked plugin features
   Hooked plugin features
    * LuckPerms Contexts
    * PlaceholderAPI Placeholders

 * Troubleshooting
   Troubleshooting
    * Report a bug
    * Request a feature
    * Ask for support

Table of contents
 * Features
    * Plugins we hook into:
       * Chat
       * Vanish
       * World
   
    * Plugins that use our API:

 * Intended usage
 * Bot Permissions
    * Server Permissions
    * Channel Permissions

 * Installation
 * Donations
 * Developers
 * Data usage
    * Data collection

 * Update checking


HOME



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

Discord SpigotMC BukkitDev

Latest Release Latest Snapshot

Supports All Minecraft Versions from 1.7.9 to 1.20.x

We only give support for the latest release/dev builds; please update before
asking for help


FEATURES🔗

 * Bridge between Minecraft and Discord chats
 * Forward your Minecraft Console to a Discord text channel
 * Broadcast alerts based on certain events
 * Voice Proximity through the Discord Voice Chat (voice.yml)
 * Require linking accounts (or certain role/s) to play (linking.yml)
 * Support for popular chat plugins (listed below)
 * Highly customizable


PLUGINS WE HOOK INTO:🔗

 * CHAT🔗
   
   * Herochat, LegendChat, LunaChat, TownyChat, VentureChat

 * VANISH🔗
   
   * Essentials, PhantomAdmin, SuperVanish, VanishNoPacket

 * WORLD🔗
   
   * Multiverse
 * Vault
 * LuckPerms
 * PlaceholderAPI - DiscordSRV Expansion Placeholders


PLUGINS THAT USE OUR API:🔗

 * DiscordSRV StaffChat
 * ChatControlRed
 * CMI
 * Plan
 * EmojiChat
 * PurpleIRC
 * ChatReplay
 * AuctionHouse
 * Staff Facilities
 * Staff++
 * LiteBansBridge
 * MCSF (My Christian Swear Filter)
 * MZP-VoteParty
 * InteractiveChat DiscordSRV Addon (Not associated with DiscordSRV)
 * DiscordSRVUtils (Not associated with DiscordSRV)
 * ActivityRoles
 * EconomyShopGUI
 * DiscordSchematicUploader (Not associated with DiscordSRV)
 * If you would like your plugin listed here, please bring it to granny's
   attention in our Discord server.


INTENDED USAGE🔗

By using this plugin, you are able to give players the ability to chat in-game
with players on your Discord server, as well as having people on the Discord
server be able to chat with people in the minecraft server - This can be useful
for players that still want to communicate with players in-game, but can't
access the Minecraft server for whatever reason.

This plugin has a remote console feature. You can designate a text channel for
the plugin to forward console messages, which also runs all messages sent into
that channel 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, you can have some server roles have access to see the console,
while also not allowing them to send messages in that channel, thus creating a
read-only console for trusted staff members.

Both chat and console are toggleable through the configuration file. Some
options can be refreshed with /discordsrv reload by an OP or a player with the
discordsrv.reload permission.


BOT PERMISSIONS🔗

SERVER PERMISSIONS🔗

Permission

Features

Manage Roles

role synchronization and adding roles to linked players

Manage Channels

channel topic updater and the voice module

Ban Members

ban synchronization

Manage Nicknames

nickname synchronization

Manage Webhooks

experimental webhook usage (Server-wide permission is recommended, but can be
applied on a per-channel basis)

--------------------------------------------------------------------------------

CHANNEL PERMISSIONS🔗

Permission

Features

Read Text Channels & See Voice Channels and Send Messages

Required for DiscordSRV's channel options (including console and voice lobby),
the voice module category and any other channels you want for canned responses

Manage Messages

when messages are deleted by playerlist & chat channel commands

Embed Links

optionally for embedding ingame-posted links and required when embed messages
are used death, join/Leave

Mention @everyone, @here and All Roles

for mentioning @everyone if added to allowed mentions in config.yml and mentions
enabled

Add Reactions and Read Message History

for when the bot reacts with "💬" and "❗" to notify a truncated message is being
sent from Discord to Minecraft

Move Members, Mute Members and Manage Permissions

required for the voice lobby and voice category


INSTALLATION🔗

Visit the Installation page for clear and in-depth instructions on installing
and setting up DiscordSRV.


DONATIONS🔗

First off, thank you from the bottom of my heart for the pizza. If you would
like to donate, go to https://scarsz.me/donate. $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 (DiscordSRV version 1.18.0+) to
your project. You also need to add the JDA repository. For an example of this,
see DiscordSRV-ApiTest. Be sure to add "DiscordSRV" to your plugin's plugin.yml
depends/softdepends list.

MavenGradle

<repository>
    <id>dv8tion</id>
    <name>m2-dv8tion</name>
    <url>https://m2.dv8tion.net/releases</url>
</repository>
...
<repository>
    <id>Scarsz-Nexus</id>
    <url>https://nexus.scarsz.me/content/groups/public/</url>
</repository>  
...  
<dependency>
    <groupId>com.discordsrv</groupId>
    <artifactId>discordsrv</artifactId>
    <version>1.26.2</version>
    <scope>provided</scope>
</dependency>


maven {
    name 'm2-dv8tion'
    url 'https://m2.dv8tion.net/releases'
}
repositories {
    maven { url 'https://nexus.scarsz.me/content/groups/public/' }
}  
dependencies {
    compileOnly 'com.discordsrv:discordsrv:1.26.2'
}






DATA USAGE🔗


DATA COLLECTION🔗

Anything and everything shown at https://bstats.org/plugin/bukkit/DiscordSRV
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.yml file.


UPDATE CHECKING🔗

DiscordSRV checks for updates using GitHub's API, and makes sure the version is
safe to use via a minimum version (security feature), you may disable update
checking by setting UpdateCheckDisabled to true in the config.yml file; however
this may leave your server at risk if there is a security issue/exploit and
you're running a vulnerable version.

Next Frequently Asked Questions

Made with Material for MkDocs