#communicate #minecraft-server #rcon #protocols #utility #command-line-tool #configuration

bin+lib managecraft

A CLI Utility to communicate with your Minecraft server over the RCON protocol

1 unstable release

0.1.0 Jun 17, 2021

#909 in Configuration

MIT license

11KB
157 lines

managecraft 🏗️

A CLI Utility to communicate with your Minecraft server over the RCON protocol

Build Badge License Badge

Command Line Utility Quick Start

Use managecraft --help or managecraft <subcommand> --help for more information about available commands

managecraft say "Hello Server!"

You'll see output of [Rcon] Hello Server! in the server log as well as in game

Library Quick Start

// Create Server Settings and Client
let settings = settings::Settings::new()?;
let mut client = Client::new(settings).await?;

// Send a command
let c = String::from("time set day");
client.execute(commands::Execute { command: c }).await?;;

Configuration

Setting up configuration for connecting to the server can be done in three ways. Each subsequent step will update any matching values from previous setps.

  1. Managecraft will set default values for all properties
Url: 0.0.0.0
Port: 25575
Password: "test"
  1. A configuration file can be created in your home diretory at $HOME/.config/managecraft.toml to overwrite some or all default values

Creating a config file with only a pasword field will leave all default values but overwrite the password value

# $HOME/.config/managecraft.toml

password="hunter2"
  1. Environment variables can also be created to set configuration values. Any environment variable prefixed with MANAGECRAFT_ will be considered and if matches will overwrite a property.

This will set the port value to 12345 overwriting default config as well as a port value specified in the config file from step 2.

MANAGECRAFT_PORT=12345 managecraft save-all

Dependencies

~6–16MB
~193K SLoC