Merge pull request #34 from HorlogeSkynet/master

Adds a `-w` option to throttle commands execution

.gitignore

@@ -2,5 +2,9 @@
 *.o
 *.dev
 *.win
+*.txt
 *.layout
-*.project
+*.project
+mcrcon
+todo
+*.plist

.travis.yml

@@ -0,0 +1,20 @@
+language: c
+sudo: false
+dist: trusty
+cache:
+  ccache: true
+compiler:
+- gcc
+- clang
+env:
+  global:
+  - EXTRAFLAGS='-v'
+  - PREFIX="${HOME}"
+install:
+- 'true'
+script:
+- make
+- ./mcrcon -h
+- ./mcrcon -v
+- make install
+- make uninstall

CHANGELOG.md

@@ -0,0 +1,67 @@
+#### Version history:
+
+###### 0.6.2
+ - Set default address to localhost
+
+###### 0.6.1
+ - Color coding fixed
+    * Thanks to Hagb @ Github
+
+###### 0.6.0
+ - Version numbering changed to more sane system (0.0.5 -> 0.6.0)
+ - Fixed munged output
+ - Support for using environment variables to set some basic options
+ - Cleaned networking code
+ - Various code cleanups
+ - Changes and updates in usage text and error reporting
+ - Version option flag (-v) added
+ - Man page added 
+ - Proper makefile added
+
+###### 0.0.5
+  - IPv6 support!
+     * Thanks to 'Tanja84dk' for addressing the real need of IPv6.
+
+  - Fixed bug causing crash / segmentation fault (invalid write) when receiving malformed rcon packet.
+
+  - Program makes use of C99 feature (variable-length arrays) so "-std=gnu99" flag on
+    GCC-compiler must be used to avoid unecessary warnings.
+
+  - Rcon receive buffer is now bigger (2024 bytes -> 10240 bytes).
+     * Thanks to 'gman_ftw' @ Bukkit forums.
+
+  - Fixed invalid error message when receiving empty rcon packet (10 bytes).
+     * Thanks to 'pkmnfrk' @ bukkit forums.
+
+  - Terminal mode now closes automatically when rcon socket is closed by server
+    or if packet size cannot be retrieved correctly.
+
+  - Client now tries to clean the incoming socket data if last package was out of spec.
+
+###### 0.0.4
+  - Reverted back to default getopts options error handler (opterr = 1).
+    Custom error handler requires rewriting.
+  - Some cosmetic changes in program output strings.
+  - Program usage(); function now waits for enter before exiting on Windows.
+
+###### 0.0.3
+  - Colors are now supported on Windows too!
+  - Terminal mode is now triggered with "-t" flag. "-i" flag still works for
+    backwards compatibility.
+  - Bug fixes (Packet size check always evaluating false and color validity
+    check always evaluating true).
+
+###### 0.0.2
+  - License changed from 'ISC License' to 'zlib/libpng License'.
+  - Bug fixes & code cleanups
+  - Interactive mode (-i flag). Client acts as interactive terminal.
+  - Program return value is now the number of rcon commmands sent successfully.
+    If connecting or authentication fails, the return value is -1.
+  - Colors are now enabled by default. Now '-c' flag disables the color support.
+
+###### 0.0.1
+  - Added experimental support for bukkit colors.
+    Should work with any sh compatible shell.
+  - Packet string data limited to max 2048 (DATA_BUFFSIZE) bytes.
+    No idea how Minecraft handles multiple rcon packets.
+    If someone knows, please mail me so I can implement it.

INSTALL.md

@@ -0,0 +1,22 @@
+Compiling and installing
+------------------------
+
+Only dependency is C library and POSIX getopt support. 
+
+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.
+
+Or you can just run "make":
+
+    make           - compiles mcrcon
+    make install   - installs compiled binaries and manpage to the system
+    make uninstall - removes binaries and manpage from the system
+    
+    file install locations:
+        /usr/local/bin/mcrcon
+        /usr/local/share/man/man1/mcrcon.1
+
+Makefile "install" and "uninstall" rules are disabled on windows.

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2013, Tiiffi <tiiffi --> gmail_dot_com>
+Copyright (c) 2012-2019, Tiiffi <tiiffi at gmail>
 
 This software is provided 'as-is', without any express or implied
 warranty. In no event will the authors be held liable for any damages
@@ -17,4 +17,5 @@ freely, subject to the following restrictions:
   misrepresented as being the original software.
 
   3. This notice may not be removed or altered from any source
-  distribution.
+  distribution.
+  

Makefile

@@ -0,0 +1,49 @@
+# if you want to cross compile
+# export PATH=$PATH:/path/to/compiler/bin
+# export CROSS_COMPILE=arm-none-linux-gnueabi-
+# make
+
+EXENAME = mcrcon
+PREFIX ?= /usr/local
+
+INSTALL = install
+LINKER =
+RM = rm -v -f
+
+CC = cc
+CFLAGS = -std=gnu99 -Wall -Wextra -Wpedantic -Os -s
+EXTRAFLAGS ?= -fstack-protector-strong
+
+ifeq ($(OS), Windows_NT)
+	LINKER = -lws2_32
+	EXENAME = mcrcon.exe
+	RM = cmd /C del /F
+endif
+
+ifeq ($(shell uname), Darwin)
+	INSTALL = ginstall
+	CFLAGS = -std=gnu99 -Wall -Wextra -Wpedantic -Os
+endif
+
+.PHONY: all
+all: $(EXENAME)
+
+$(EXENAME): mcrcon.c
+	$(CROSS_COMPILE)$(CC) $(CFLAGS) $(EXTRAFLAGS) -o $@ $< $(LINKER)
+
+ifneq ($(OS), Windows_NT)
+.PHONY: install
+install:
+	$(INSTALL) -vD $(EXENAME) $(DESTDIR)$(PREFIX)/bin/$(EXENAME)
+	$(INSTALL) -vD -m 0644 mcrcon.1 $(DESTDIR)$(PREFIX)/share/man/man1/mcrcon.1
+	@echo "\nmcrcon installed. Run 'make uninstall' if you want to uninstall.\n"
+
+.PHONY: uninstall
+uninstall:
+	$(RM) $(DESTDIR)$(PREFIX)/bin/$(EXENAME) $(DESTDIR)$(PREFIX)/share/man/man1/mcrcon.1
+	@echo "\nmcrcon uninstalled.\n"
+endif
+
+.PHONY: clean
+clean:
+	$(RM) $(EXENAME)

README.md

@@ -1,10 +1,90 @@
-####Compiling:
+# mcrcon
 
-```gcc -std=gnu11 -pedantic -Wall -Wextra -O2 -s -o mcrcon mcrcon.c```
-
-On windows, remember to link with winsockets.
-Add ```-lws2_32``` to compiler command line on Mingw GCC.
+mcrcon is console based Minecraft [rcon](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) client for remote administration and server maintenance scripts.
 
 ---
 
-More info [here](http://forums.bukkit.org/threads/admin-rcon-mcrcon-remote-connection-client-for-minecraft-servers.70910/).
+### Installing:
+
+##### via packet manager:
+See https://pkgs.org/download/mcrcon for available packages in various Linux distros.
+
+- Gentoo Linux: https://packages.gentoo.org/packages/games-util/mcrcon
+- Arch Linux: https://aur.archlinux.org/packages/mcrcon/
+
+##### from sources:
+```sh
+git clone https://github.com/Tiiffi/mcrcon.git
+cd mcrcon
+make
+sudo make install
+```
+Check [INSTALL.md](INSTALL.md) for more details.
+
+You can also download precompiled binaries*: https://github.com/Tiiffi/mcrcon/releases/latest
+
+<sub>*At the moment binaries are provided for Linux and Windows.</sub>
+
+---
+
+### Usage:
+mcrcon [OPTIONS] [COMMANDS]
+
+Sends rcon commands to Minecraft server.
+
+```
+Option:
+  -H            Server address (default: localhost)
+  -P            Port (default: 25575)
+  -p            Rcon password
+  -t            Terminal mode
+  -s            Silent mode
+  -c            Disable colors
+  -r            Output raw packets
+  -h            Print usage
+  -v            Version information
+  -w            Wait for specified duration (seconds) between each command
+```
+Server address, port and password can be set using following environment variables:
+```
+MCRCON_HOST
+MCRCON_PORT
+MCRCON_PASS
+```
+###### Notes:
+- mcrcon will start in terminal mode if no commands are given
+- Command-line options will override environment variables
+- Rcon commands with spaces must be enclosed in quotes
+
+Example:
+  ```mcrcon -H my.minecraft.server -p password "say Server is restarting!" save-all stop```
+
+---
+
+##### Enable rcon on server
+Remember to enable rcon by adding following lines to [```server.properties```](https://minecraft.gamepedia.com/Server.properties) file.
+```
+enable-rcon=true
+rcon.port=25575
+rcon.password=your_rcon_pasword
+```
+
+---
+
+##### Contact:
+
+* WWW:            https://github.com/Tiiffi/mcrcon/
+* MAIL:           tiiffi at gmail
+* IRC:            tiiffi @ quakenet
+* BUG REPORTS:    https://github.com/Tiiffi/mcrcon/issues/
+
+---
+
+### License
+
+This project is licensed under the zlib License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+<sub>Master:</sub> ![Master build](https://api.travis-ci.org/Tiiffi/mcrcon.svg?branch=master)
+<sub>Develop:</sub> ![Develop build](https://api.travis-ci.org/Tiiffi/mcrcon.svg?branch=develop)

mcrcon.1

@@ -0,0 +1,66 @@
+.\" Process this file with
+.\" groff -man -Tascii mcrcon.1
+.\"
+.TH MCRCON 1 "October 2019" "Version 0.6.2"
+.SH NAME 
+mcrcon \- send rcon commands to a Minecraft server
+.SH SYNOPSIS
+.B mcrcon [
+options
+.B ] [
+commands
+.B ]
+.SH DESCRIPTION
+mcrcon is Minecraft rcon client for remote administration and server maintenance scripts.
+.SH OPTIONS
+.IP -H
+Server address (default: localhost)
+.IP -P
+Port (default: 25575)
+.IP -p
+Rcon password
+.IP -t
+Terminal mode
+.IP -s
+Silent mode
+.IP -c
+Disable colors
+.IP -r
+Output raw packets
+.IP -h
+Print usage
+.IP -v
+Output version information
+.IP -w
+Wait for specified duration (seconds) between each command
+.PP
+Commands with spaces must be enclosed in quotes.
+.br
+mcrcon will start in terminal mode if no commands are given.
+.SH ENVIRONMENTAL VARIABLES
+Server address, port and password can be set with following environment variables:
+.PP
+\fBMCRCON_HOST
+.br
+\fBMCRCON_PORT
+.br
+\fBMCRCON_PASS\fR
+.PP
+Note that command-line options will override environment variables.
+.SH EXAMPLES
+Make rcon connection in terminal mode using default port
+.RS
+\fBmcrcon\fR -H my.minecraft.server -p password
+.RE
+.PP
+Send "weather clear" command to server using custom port 1337
+.RS
+\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
+.RS
+\fBmcrcon\fR -H my.minecraft.server -p password -w 2 "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