MarcusSlover / DCWhitelist

A Spigot / Bukkit Plugin and API for compatible Discord - Minecraft Processes and Whitelisting

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DCWhitelist

DC Whitelist is a customisable plugin you can use for yourself, or as an API for directly whitelisting users from Discord into your own Minecraft Server. DC Whitelist is available as a JAR, and thus, is compatible with only Minecraft Java Servers.

Although a fairly simple plugin, this plugin is very effective in its use, and was created for programmers to link Discord & Minecraft easier. This plugin makes use of Mojang's API as well as Spigot's API, and is customisable to a great extent. As for users, all they need to do is type out their Minecraft username in a channel, and they would automatically be whitelisted.

For Users

This plugin requires zero technical knowledge for setup. In order to connect Discord to your Minecraft Server, simply download the jar from the Releases Tab, and upload it into the /plugins/ folder of your Minecraft Server (Paper / Spigot / any derivatives - which SUPPORTS PLUGINS).

Steps to enable this plugin successfully are given below:

  • Invite FloofBot, to your Discord server by clicking on this link.
  • Provide FloofBot, permissions to - React to Emotes, Ability to View Channels.
  • Upload the DC-Whitelist JAR to the /plugins/ of your Minecraft Server.
  • Restart your server.
  • Navigate to the /plugins/DCWhitelisting/ folder on your server.
  • Click on the configuration.yml file, and begin editing it.
  • Obtain the Channel ID (where you wish to whitelist users) - if you don't know how to get a channel ID, refer to this link.
  • Restart your server / reload the plugin.
  • You're done!

If you do notice any errors on the console on server disabling, please note these are errors from JDA (Discord API), and not from this plugin. Ignore the same.

For Developers

Hiya, devs! As a developer myself, I've custom coded these functions to be very helpful during any development that you're doing! Even for new developers, this API is very comfortable to work with and charming as well!

To include the plugin as a dependency, please view the repositories and dependencies to be added into your pom.xml.

repositories:

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

dependencies:

<dependency>
    <groupId>com.github.FloofCat</groupId>
    <artifactId>DCWhitelist</artifactId>
    <version>v0.1</version>
</dependency>

(Wiki & Java Docs to be added)

Updates

  • Completion of Wiki
  • Completion of JavaDocs
  • Completed Source Code
  • Open Source

For any issues / bugs, please open up an issue on GitHub.

About

A Spigot / Bukkit Plugin and API for compatible Discord - Minecraft Processes and Whitelisting

License:GNU General Public License v3.0


Languages

Language:Java 100.0%