diff options
| author | Karel Kočí <cynerd@email.cz> | 2016-01-08 16:09:37 +0100 |
|---|---|---|
| committer | Karel Kočí <cynerd@email.cz> | 2016-01-08 16:09:37 +0100 |
| commit | 9073bf1ccac68cfaa93d4bbe5c9b1b3fe98fcd8c (patch) | |
| tree | b7eaec69cc0417d49f0f785a887d87728f1321b5 /README.md | |
| parent | b0ad3b14a12bf3725cfd571036dba7e5664d4f57 (diff) | |
| download | mcserver-wrapper-9073bf1ccac68cfaa93d4bbe5c9b1b3fe98fcd8c.tar.gz mcserver-wrapper-9073bf1ccac68cfaa93d4bbe5c9b1b3fe98fcd8c.tar.bz2 mcserver-wrapper-9073bf1ccac68cfaa93d4bbe5c9b1b3fe98fcd8c.zip | |
Change documentation and add configfile argument
Configuration options are from previous commit documented directly in
example configuration file. So they don't have to be documented in
readme.
New argument configfile was added because if user uses default paths
for configuration files, it can be sometime unclear what file was used.
This prints path to used file.
Also as small feature, if no identifier is specified as argument neither
in configuration file help text is printed.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 5 insertions, 23 deletions
@@ -23,6 +23,10 @@ mcwrapper [arguments...] IDENTIFIER Increase verbose level of output. -q, --quiet Decrease verbose level of output. + --config CONFIG_FILE + Specify configuration file to be used. + --configfile + prints used configuration file and exits. IDENTIFIER Identifier for new server. This allows multiple servers running with this @@ -73,26 +77,4 @@ Script is searching for configuration in these files (in order of precedence): * ~/.mcwrapper.conf * ~/.config/mcwrapper.conf * /etc/mcwrapper.conf - -### identifier -This option is string defining identifier of server. If this option is define, no -IDENTIFIER argument is expected on command line. If you have only one server, use -this to make command line commands shorter. - -### server -This variable is expected to be of type dictionary and contains configurations per -server. See example.conf for example. Options for servers are these: -#### directory -Defines directory where will be server executed. This way you can start server from -any directory and it will always start server in right one. -#### command -Defines command to start Minecraft server in `directory`. -#### status -Defines directory in which will be placed all status files generated by this -wrapper. - -### timeout -Numerical value, specifying time in minutes after which will be server -automatically shutdown if no player is on server. If value is less or equal zero, -automatic shutdown is disabled. If value is not specified in configuration file, 0 -is used. +Or you can use `--config` argument to specify any other file with valid content. |