diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 15 insertions, 15 deletions
@@ -11,6 +11,7 @@ Requires: Usage ----------------- +``` mcwrapper ACTION {IDENTIFIER} [args...] This script is executing Minecraft server and reads its output. From output is extracted server status and list of online players. @@ -25,16 +26,18 @@ mcwrapper ACTION {IDENTIFIER} [args...] Identifier can be any word without spaces and preferably without special characters. It is used for identifying server instances, so that multiple servers can run with this wrapper on single system. +``` How it works ----------------- -Script is reading Minercraft server standard and error output. It's looking for known lines that -signals change of server output and players joining and leaving. Minecraft server output is well -designed for information parsing. Informations are in default exported to folder /dev/shm/mcwrapper_IDENTIFIER -where IDENTIFIER is specified as argument to script. From now on will be replaced with *. +Script is reading Minercraft server standard and error output. It's looking for +known lines that signals change of server output and players joining and leaving. +Minecraft server output is well designed for information parsing. Informations are +in default exported to folder /dev/shm/mcwrapper_IDENTIFIER where IDENTIFIER is +specified as argument to script. From now on will be replaced with *. ###Status file -This file is in default configuration in path /dev/shm/mcwrapper_*/status. +This file is in default configuration in path `/dev/shm/mcwrapper_*/status`. If it exists, it contains in what status is server in the moment. Status can be: * Starting @@ -44,15 +47,12 @@ Status can be: If file not exists, then server is not running at all. ###Players file -This file in in default configuration in path /dev/shm/mcwrapper_*/players -If server is running, it constains online players. Player name per line. -If server isn't runnint, it content don't have to be valid. +This file in in default configuration in path `/dev/shm/mcwrapper_*/players` If +server is running, it constains online players. Player name per line. If server +isn't runnint, it content don't have to be valid. ##Input pipe -This is unit pipe. In default configuration is in path /dev/shm/mcwrapper_*/input_pipe. -This pipe is input to Minercraft server standard input. If you have write access rights -(default 640), then you can send any command to Minecraft server by writing to this pipe. - -###Logging -Minecraft output is automatically logged to date-time stamped file in configuration specified -folder (default /home/minecraft/log/INDETIFIER/ where IDENTIFIER is argument to script). +This is unit pipe. In default configuration is in path +`/dev/shm/mcwrapper_*/input_pipe`. This pipe is input to Minercraft server +standard input. If you have write access rights (default 640), then you can send +any command to Minecraft server by writing to this pipe. |