TheCloneArmy/mcrcon
1
0
Fork 0
mirror of https://github.com/Tiiffi/mcrcon.git synced 2025-10-27 03:11:07 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update various document files

Browse Source
This commit is contained in:
Tiiffi
2019-12-21 22:16:34 +02:00
parent cffa73d223
commit d2ebbd8f12
4 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -2,6 +2,7 @@
###### 0.7.0
- Add -w option for rcon command throttling
* Thanks HorlogeSkynet @ Github
###### 0.6.2
- Set default address to localhost

8
INSTALL.md
View File

@ -1,4 +1,4 @@
Compiling and installing
Building and installing
------------------------
Only dependency is C library and POSIX getopt support.
@ -7,9 +7,9 @@ Compiling with GCC or CLANG:
cc -std=gnu99 -Wpedantic -Wall -Wextra -Os -s -o mcrcon mcrcon.c
Note: on Window remember to link with winsockets by adding "-lws2_32" to your compiler command line.
Note: on Windows remember to link with winsock by adding `-lws2_32` to your compiler command line.
Or you can just run "make":
Or you can just run "**make**":
make - compiles mcrcon
make install - installs compiled binaries and manpage to the system
@ -19,4 +19,4 @@ Or you can just run "make":
/usr/local/bin/mcrcon
/usr/local/share/man/man1/mcrcon.1
Makefile "install" and "uninstall" rules are disabled on windows.
Makefile "**install**" and "**uninstall**" rules are disabled on windows.

6
README.md
View File

@ -12,7 +12,7 @@ See https://pkgs.org/download/mcrcon for available packages in various Linux dis
- Gentoo Linux: https://packages.gentoo.org/packages/games-util/mcrcon
- Arch Linux: https://aur.archlinux.org/packages/mcrcon/
##### from sources:
##### building from sources:
```sh
git clone https://github.com/Tiiffi/mcrcon.git
cd mcrcon
@ -57,7 +57,9 @@ MCRCON_PASS
- Rcon commands with spaces must be enclosed in quotes
Example:
```mcrcon -H my.minecraft.server -p password -w 2 "say Server is restarting!" save-all stop```
> Send three commands ("say", "save-all", "stop") and wait five seconds between the commands.
```mcrcon -H my.minecraft.server -p password -w 5 "say Server is restarting!" save-all stop```
---

8
mcrcon.1
View File

@ -37,7 +37,7 @@ Output version information
Commands with spaces must be enclosed in quotes.
.br
mcrcon will start in terminal mode if no commands are given.
.SH ENVIRONMENTAL VARIABLES
.SH ENVIRONMENT VARIABLES
Server address, port and password can be set with following environment variables:
.PP
\fBMCRCON_HOST
@ -58,9 +58,9 @@ Send "weather clear" command to server using custom port 1337
\fBmcrcon\fR -H my.minecraft.server -P 1337 -p password "weather clear"
.RE
.PP
Send three commands to server ("say", "save-all" and "stop"), and wait 2 seconds between them
Send three commands ("say", "save-all", "stop") and wait five seconds between the commands.
.RS
\fBmcrcon\fR -H my.minecraft.server -p password -w 2 "say Server is restarting!" save-all stop
\fBmcrcon\fR -H my.minecraft.server -p password -w 5 "say Server is restarting!" save-all stop
.RE
.SH BUGS
Bugs can be reported to \fBtiiffi+mcrcon at gmail\fR or \fBhttps://github.com/Tiiffi/mcrcon/issues/\fR
Report bugs to \fBtiiffi+mcrcon at gmail\fR or \fBhttps://github.com/Tiiffi/mcrcon/issues/\fR