Categorygithub.com/benwebber/craftctl
modulepackage
0.1.1
Repository: https://github.com/benwebber/craftctl.git
Documentation: pkg.go.dev

# README

craftctl

craftctl is a command-line Minecraft console client.

Written in Go, craftctl runs on same platforms Minecraft does.

Usage

craftctl uses the RCON protocol to interact with a Minecraft instance.

First, enable the RCON interface:

# server.properties
enable-rcon=true
rcon.password=<password>

then point craftctl to your server:

$ craftctl -p <password> list

Commands

Specify commands with or without a leading slash. The following are equivalent:

$ craftctl help
$ craftctl /help

Configuration

Configure craftctl using command-line flags or environment variables.

OptionEnvironment VariableDefaultDescription
-H/--hostCRAFTCTL_HOSTlocalhostRCON hostname or IP address
-P/--portCRAFTCTL_PORT25575RCON password
-p/--passwordCRAFTCTL_PASSWORDpasswordRCON password

Installation

Install the Go toolchain, then:

$ go get github.com/benwebber/craftctl
$ go install github.com/benwebber/craftctl

# Packages

No description provided by the author
No description provided by the author

# Constants

No description provided by the author

# Variables

No description provided by the author