Giter Site home page Giter Site logo

discordmc's Introduction

DiscordMC

DiscordMC is a program that syncs a Minecraft server with Discord channels without the usage of mods. It supports syncing to 2 different channels:

  • An admin console channel one where the raw logs are dumped and any messages sent in the channel will be run as a command. admin
  • A server chat channel one where the logs are formatted nicely and any messages sent in the channel will be broadcasted to the Minecraft server as a say ... command admin

By relying on the built-in RCON protocol instead of installing as a mod, this allows DiscordMC to be a drop-in solution in a variety of scenarios.

Getting started

Installing

  • Installing through the Go toolchain:
    go get github.com/chenbh/discordmc
    
  • From GitHub releases: TODO: offer prebuilt binaries

Usage

  • required --token: Discord bot token
  • optional --admin-channel: Discord Channel ID to sync the server console with (bot must have view/send message permissions)
  • optional --chat-channel: Discord Channel ID to sync the server chat log with (bot must have view/send message permissions). Edit channel permissions can also be granted to have DiscordMC update the channel topic with the current server status periodically
  • optional --status-interval: Interval at which to refresh the server status in the chat channel. Must be empty string to disable it, or a valid Go duration string. Defaults to 5m
  • required --host: Host (IP or URL) of the Minecraft server. Defaults to localhost
  • required --port: Port of the RCON server. Defaults to 25575
  • required --pass: Password for RCON server
  • required --log: Path to the Minecraft server's log file. Defaults to logs/latest.log

discordmc's People

Contributors

chenbh avatar

Watchers

 avatar  avatar

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.