Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.21 KB

README.asciidoc

File metadata and controls

34 lines (25 loc) · 1.21 KB

Clicraft ReadMe

A command-line minecraft server wrapper.

Warning
This software is unmaintained. Use at your own risk!

Overview

Clicraft is a command-line wrapper for operation and administration of a minecraft-compatible server. It is written in bash and uses tmux to daemonize and communicate with the server process.

Clicraft strives to be simple, robust, and useful. With it, you can:

  • Manage (start, stop, update) a minecraft-compatible server from the command line

  • Easily use third-party minecraft utilities (stop referring to --help output for basic options)

  • Programmatically or interactively send commands to the server console

  • Extend functionality by writing your own hooks called action scripts

Documentation

The full documentation for clicraft is kept in AsciiDoc format under the doc/ directory in the source distribution. It can be viewed at https://DMBuce.github.io/clicraft.

Basic documentation can be found in these files: