Giter Club home page Giter Club logo

mindustry-discord-relay's Introduction

Mindustry-Discord-Relay

Mindustry-Discord-Relay (MDDR) is a plugin for Mindustry which allows you to connect your server to discord (using a webhook) and relay information from Mindustry to Discord.


Installation

Method A:

Download the source and edit the Main class (Probably by cloning the source and opening it in an IDE so you can export the plugin easily). On line 32 you should see private String discordWebhook = "<INSERT_DISCORD_WEBHOOK_HERE>";, change <INSERT_DISCORD_WEBHOOK_HERE> to your webhook. Once you've changed that, you can export the plugin!

Once exported, grab the jar file (located in build/libs) and place it into config/mods which is located in your server's directory (folder) and you should be good to run your server!

Method B:

Head on over to the releases tab and download the recent .jar file. Place it in config/mods which is located in your server's directory (folder) and run your server.

Once the server has booted up, you will get "An error occured when trying to send a message via Discord Webhooks.", don't panic about this. In your console do setdiscordwebhook <INSERT_DISCORD_WEBHOOK_HERE> (of course, you don't include the "<>" in there) and you should be good to go!

Every time you boot up the server, you will need to do setdiscordwebhook <INSERT_DISCORD_WEBHOOK_HERE> unless you use Method A.


Usage

The plugin will automatically handle server start ups, game over events, new map events, players leaving and joining, and the chat event. If any of these events are fired, information will be relayed to discord via your webhook. This can allow for a great console system for Mindustry within discord!

You can, however, send custom messages as well! Doing senddiscordmessage <message> will send a message to your discord server via your webhook! Example: senddiscordmessage I am a cool dude!.


Licence

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

mindustry-discord-relay's People

Contributors

jaskowicz1 avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

troit5ky

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.