aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKarel Kočí <cynerd@email.cz>2015-11-14 13:50:24 +0100
committerKarel Kočí <cynerd@email.cz>2015-11-14 13:50:24 +0100
commit426b999aa8b129e66a0f5b5b3aceee371b40fe65 (patch)
tree6142291d78ec12e15349021d2f273e89c4ffc838 /README.md
parent9e2636ae5da397ea69d521f2b2036cee3e428754 (diff)
downloadmcserver-wrapper-426b999aa8b129e66a0f5b5b3aceee371b40fe65.tar.gz
mcserver-wrapper-426b999aa8b129e66a0f5b5b3aceee371b40fe65.tar.bz2
mcserver-wrapper-426b999aa8b129e66a0f5b5b3aceee371b40fe65.zip
Remove actions from mcwrapper
Actions that would be send to server are useless when as same fast is possible write to file pipe. This way is code more clear and allows more expansions to the future. Also is consistent with planed Man in the middle server.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 7 insertions, 17 deletions
diff --git a/README.md b/README.md
index 38bbe09..a5041c1 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
MINECRAFT-WRAPPER
=================
-
-Python server wrapper for extracting informations about server status and list of online players.
+Python server wrapper for extracting informations about server status and list of
+online players.
Requires:
-----------------
@@ -12,7 +12,7 @@ Requires:
Usage
-----------------
```
-mcwrapper [arguments...] ACTION ...
+mcwrapper [arguments...] IDENTIFIER
This script is executing Minecraft server and reads its output. From output is
extracted server status and list of online players.
@@ -24,20 +24,10 @@ mcwrapper [arguments...] ACTION ...
-q, --quiet
Decrease verbose level of output.
- Common action arguments
- IDENTIFIER
- Identifier for new server instance. This allows multiple server
- instances running with this wrapper.
- Identifier is word without spaces and preferably without special
- characters.
-
- ACTION and it's arguments
- start INDETIFIER
- Start server under "IDENTIFIER"
- stop IDENTIFIER
- Sends stop command to server under "IDENTIFIER"
- say IDENTIFIER {message...}
- Sends message to server chat
+ IDENTIFIER
+ Identifier for new server. This allows multiple servers running with this
+ wrapper. Identifier is word without spaces and preferably without special
+ characters.
```
How it works