mcvisor

module
v0.0.0-...-80caa2b Latest Latest
Warning

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

Go to latest
Published: May 2, 2022 License: AGPL-3.0

README

mcvisor

go 1.18 Lint Test Latest binaries AGPL-3.0 Go Report Card

mcvisor is a Minecraft server supervisor. It launches and monitors a Minecraft server. It also starts a Discord bot that can notify a channel of event and accepts commands.

Planned features

(Non exhaustive list)

  • General
    • JSON configuration
    • Resilient architecture based on supervisor trees
    • Rotating file logging
    • Console logging
  • Minecraft
    • Server starting, stopping and restarting
    • Automatic restarting
    • Capture server logs
    • Capture console output
    • Monitor connectivity
    • !start, !stop, !restart and !shutdown command to control the server
    • !online command to list the players that are connected to the server
    • !status command to show the server status
    • !console command to send commands to the server console
    • Preconfigured jobs
    • Scheduled restarts/scripts
    • Restart on unreachable status (maybe)
  • Discord Bot
    • Automatic reconnection
    • Accept commands
    • User, channel and role permissions using Discord IDs
    • Checks configuration on connection
    • Notifications in a given channel
  • Commands
    • Extensible command system with permission checks
    • !help command to list allowed commands

License

Unless explicitly stated otherwise all files in this repository are licensed under the GNU Affero General Public License version 3 (AGPL-3).

Directories

Path Synopsis
cmd
mcvisor command
pkg

Jump to

Keyboard shortcuts

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