aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKarel Kočí <cynerd@email.cz>2016-10-23 12:53:45 +0200
committerKarel Kočí <cynerd@email.cz>2016-10-23 12:53:45 +0200
commitf556c681a5afae36a7d7c11ade5854a6de4a0896 (patch)
tree90d4442c0b5a20fc589faf9e10866b8eba868e37 /README.md
parentfcbf1c073d90c09e27b2ba69ca62b89ad6e1b063 (diff)
downloadmcserver-wrapper-f556c681a5afae36a7d7c11ade5854a6de4a0896.tar.gz
mcserver-wrapper-f556c681a5afae36a7d7c11ade5854a6de4a0896.tar.bz2
mcserver-wrapper-f556c681a5afae36a7d7c11ade5854a6de4a0896.zip
Add message of the day feature
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 19 insertions, 11 deletions
diff --git a/README.md b/README.md
index 7d3ee28..52ea73e 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
MCSERVER-WRAPPER
================
Minecraft server wrapper written in Python3 that extracts server status and list
-of online players.
+of online players and more.
Requires:
-----------------
@@ -34,11 +34,16 @@ positional arguments:
command Command to be executed to start Minecraft server.
optional arguments:
- -h, --help show this help message and exit
- --verbose, -v Increase verbose level of output
- --quiet, -q Decrease verbose level of output
- --status-file, -s Outputs server status to file "status"
- --players-file, -p Outputs list of online players to file "players"
+ -h, --help show this help message and exit
+ --verbose, -v Increase verbose level of output
+ --quiet, -q Decrease verbose level of output
+ --status-file, -s Outputs server status to file "status"
+ --players-file, -p Outputs list of online players to file "players"
+ --mod-file MOD_FILE, -m MOD_FILE
+ Prints periodically random line from given file as
+ message of the day.
+ --mod-time MOD_TIME Period used for message of the day in seconds. In
+ default 900 (15 minutes).
```
### How it works
@@ -74,8 +79,11 @@ This file in in status directory and is named as `players`. If server is running
it contains online players. Player name per line. If server isn't running, it
content don't have to be valid.
-MCWRAPPER-TERMINAL
-------------------
-This application is going to be used for interactive terminal access to minecraft
-server console. It should use latest minecraft server log as input and output will
-be pushed to input pipe of mcwrapper. This app is currently in development.
+### Message of the day
+This prints to players various short messages in given interval. Message is from
+file passed as --mod-file and it's randomly selected line. This file is read on
+wrapper start, so if you edit it while it's running, no change will happen unless
+you send USR1 signal to mcwrapper server. You can use this simple script:
+```
+[ -f server.pid ] && kill -USR1 $(cat server.pid)
+```