discordmc

command module
v0.0.0-...-ca1d6f1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2021 License: MIT Imports: 16 Imported by: 0

README

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

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL