https://github.com/bence98/minecartd

A Linux daemon for managing Minecraft servers
https://github.com/bence98/minecartd

daemon java java-8 java8 linux linux-daemon minecraft minecraft-server network networking service shell-script shellscript systemd systemd-service

Last synced: about 2 months ago
JSON representation

A Linux daemon for managing Minecraft servers

• Host: GitHub
• URL: https://github.com/bence98/minecartd
• Owner: bence98
• Created: 2017-12-30T10:31:56.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-02T23:41:26.000Z (almost 7 years ago)
• Last Synced: 2024-11-07T04:44:19.879Z (3 months ago)
• Topics: daemon, java, java-8, java8, linux, linux-daemon, minecraft, minecraft-server, network, networking, service, shell-script, shellscript, systemd, systemd-service
• Language: Java
• Size: 26.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MineCartD

A Linux daemon for managing Minecraft servers  

by CsokiCraft

## Installation

Downloads can be found on the [GitHub releases page](https://github.com/bence98/MineCartD/releases).  

Run the `minecartd_install` script. It downloads and installs `minecartd`, sets up a new user account, generates default config file and servers directory, and installs and enables a `systemd` service for `minecartd`.  

In general, using the service is the preferred method. However, on systems without `systemd`, or when testing the software, you may opt to disable it (`systemctl stop minecartd && systemctl disable minecartd`) and use the command line instead (`/usr/bin/minecartd` or `java -jar minecartd.jar`).

## Usage

On the server, run `minecartd`, either from command line or via `systemd` service.

Then on the client, connect to it with an appropriate tool (ex. `telnet`) to access the Command Interface

## Setting up the server

### Config

The config file consists of `key=value` pairs. Lines starting with `#` won't be interpreted. If the config file doesn't exist, `minecartd` will attempt to create it.

#### Settings:

* `dir`: The directory holding the servers' directories. Default: `/var/lib/minecartd/servers`

* `port`: The TCP port for the Command Interface. Default: `40960`

### Command-line parameters

* `--cfgfile|-f `: use this config file instead of `/etc/minecartd.conf`

* `--gen-cfg|-C`: generate config and quit. Won't launch Command Interface. Can't be used with `-S`

* `--stop|-S`: connect to a server on `localhost` and send `STOP` to it (stops all Minecraft servers and the `minecartd` host). Can't be used with `-C`

* `--tmpfile|-t `: set the temp file's location. If this is not given, it will default to `/tmp/minecartd.tmp`

* `--no-tmpfile|-T`: don't create a temp file. This is not recommended.

## Using the Command Interface on the client

When connection is established to the `minecartd` server, you'll see a welcome prompt telling the server's `minecartd` version. If there's no prompt, that means there's a connection failure. Check your connection as well as verify that the server is up and running.

### Command Interface commands

* `help`: Lists all commands

* `list`: Lists all servers

* `STOP`: Stops all servers and quits

* `start `: Starts the Minecraft server

* `kill `: Kills the Minecraft server. Use only when the server is beyond-recoverable frozen. You may lose your world! You have been warned.

* `cmd  stop`: The proper way of closing the Minecraft server

* `cmd  `: Execute a Minecraft command as an Admin

* `log  [ln]`: Outputs the last `ln` lines (default: 10, max: 127) of the output of the Minecraft server