Giter Club home page Giter Club logo

dcmchat's Introduction

Dcmchat - minecraft & discord chat integration

repo-size-badge license-badge stars-badge activity-badge

A Minecraft plugin that connects your discord server to the Minecraft server

Table Of Contents

  1. General Info
  2. Features
  3. Commands
  4. Installation
  5. Configuring
  6. Building from source
  7. Warnings
  8. Dependencies and Credits
  9. Contributing
  10. License
  11. Others

General Info

The plugin's purpose is to connect the discord text channel with Minecraft chat.

The project was done for the 1.19.2 Minecraft version.

The plugin will display messages from Minecraft on the discord channel and vice versa.

The project was done purely for learning and fun purposes. Do not take this plugin seriously.

Features

  • Displays join/leave message on the discord channel
  • Displays player deaths
  • Displays player advancements
  • Displays player messages on discord
  • Displays discord messages on Minecraft chat
  • Commands
    • Status of discord server on minecraft chat
    • Configure options of the plugin from minecraft chat

Commands

Command Name Usage Example
Status /status /status
Config /config [enable-tag \ enable-console \ channel] /config enable-tag true

Installation

You need a 1.20.1 papermc server.

When the server is installed place the freshly downloaded plugin in the plugins/ folder.

Start a server to generate needed files (Don't worry about errors for now).

Configuring

You need a discord bot for this.

  1. Create one at Discord Developer Portal.

    Make sure to invite the bot to your server!

  2. Copy the bot token to your clipboard.

  3. Go to plugins/dcmchat/ and open the config.yml file with a text editor.

  4. Replace "server" with your server name (the server with the bot).

  5. You need to set the channel.

    There are two options:

    • Create a text channel with a "mc-chat" name.
    • Change the "mc-chat" to your channel name.
  6. If you want the plugin to display discord messages in the console or show the discord user's tag choose an option and change "false" to "true"

  7. Lastly add a line to config.yml saying:

    BOT_TOKEN: YOUR_BOT_TOKEN

Replace the "YOUR_BOT_TOKEN" with the actual token.

Building from source

  1. Clone the repository.

    $ git clone https://github.com/Zielin0/Dcmchat.git
  2. Open created folder with IntelliJ IDEA.

  3. Install all maven dependencies.

    • If you want the jar to be compiled directly to your plugins directory add this to pom.xml in maven-jar-plugin section:
    <configuration>
      <outputDirectory>C:\path\to\plugins</outputDirectory>
    </configuration>
  4. Run maven scripts first clean then package.

  5. Plugin should appear in the target/ directory (only if you skipped outputDirectory configuration).

Warnings

The plugin is not recommended for discord and Minecraft servers more significant than 75 users/players.

Dependencies and Credits

Dependencies:

Credits:

Contributing

Contributions are welcome just make sure the code works.

Also, please describe your changes / added features if you want to contribute.

License

The project is under the MIT License.

Others

If the plugin throws an unexpected error PLEASE report it!

You can report issues and errors at Issues Page.

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.