Update BUILDING.md

Minecraft servers have a longstanding bug that omits newlines
when sending messages via RCON. This patch manually inserts
newlines to address the issue.

Reference: https://bugs.mojang.com/browse/MC-7569

Fixes #1

.gitignore

@@ -7,3 +7,4 @@
 *.project
 mcrcon
 todo
+*.plist

.travis.yml

@@ -1,20 +0,0 @@
-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

BUILDING.md

@@ -0,0 +1,34 @@
+Building and installing
+-----------------------
+
+### Prerequisites
+
+- GCC compatible compiler
+- make
+- POSIX.1 support
+   * getopt()
+   * strcasecmp()
+   * tcflush()
+
+---
+
+### Compiling
+
+    cc -std=gnu99 -Wpedantic -Wall -Wextra -Wno-gnu-zero-variadic-macro-arguments -O2 -o mcrcon mcrcon.c
+    
+>[!NOTE]
+>If you are compiling on Windows remember to link with winsock by adding `-lws2_32` to your compiler command line.
+
+---
+
+Or you can 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 not available on Windows.

CHANGELOG.md

@@ -1,9 +1,43 @@
-####Version history:
-######0.6.1
+#### Version history:
+
+###### 0.8.0
+ - Implement support for multipacket responses
+ - Add support for Valve style rcon authentication
+ - Add experimental UTF-8 support for Windows
+ - Change maximum packet size to correct value (4096 -> 4106)
+ - Attempt to add missing newlines in bugged Minecraft servers
+    * Implemented for responses to the 'help' command and unknown commands
+ - Print auth failed message to stderr instead of stdout
+ - Fail immediately if received packet size is out of spec
+ - Return proper exit code from run_terminal_mode()
+ - Add error messages to rcon_command() function
+
+###### 0.7.2
+ - Quit gracefully when Ctrl-D or Ctrl+C is pressed
+ - Remove "exit" and "quit" as quitting commands
+    * These are actual rcon commands on some servers
+ - Suppress compiler warning (strncpy)
+ - Fix erroneous string length in packet building function
+ - Fix typo in ANSI escape sequence for LCYAN
+ - Make stdout and stderr unbuffered
+
+###### 0.7.1
+ - Deprecate `-i` flag for invoking terminal mode
+ - Add workaround to prevent server-side bug.
+   * https://bugs.mojang.com/browse/MC-154617
+
+###### 0.7.0
+ - Add -w option for rcon command throttling
+    * Thanks HorlogeSkynet @ Github
+
+###### 0.6.2
+ - Set default address to localhost
+
+###### 0.6.1
  - Color coding fixed
     * Thanks to Hagb @ Github
 
-######0.6.0
+###### 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
@@ -14,7 +48,7 @@
  - Man page added 
  - Proper makefile added
 
-######0.0.5
+###### 0.0.5
   - IPv6 support!
      * Thanks to 'Tanja84dk' for addressing the real need of IPv6.
 
@@ -34,20 +68,20 @@
 
   - Client now tries to clean the incoming socket data if last package was out of spec.
 
-######0.0.4
+###### 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
+###### 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
+###### 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.
@@ -55,25 +89,9 @@
     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
+###### 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.
-
-####TODO:
-  - Make the receive buffer dynamic??
-  - Change some of the packet size issues to fatal errors.
-  - Code cleanups.
-  - Check global variables (remove if possible).
-  - Add some protocol checks (proper packet id check etc..).
-  - Preprocessor (#ifdef / #ifndef) cleanups.
-  - Follow valve rcon protocol standard strictly?
-  - Multiple packet support if minecraft supports it?!
-  - Investigate if player chat messages gets sent through rcon.
-    If they are, the messaging system requires rewriting.
-  - Name resolving should be integrated to connection creation function.
-  - Dont try to cleanup the socket if not authenticated
-  - Better sockets error reporting
-  - Better error function (VA_ARGS support)

INSTALL.md

@@ -1,22 +0,0 @@
-Compiling and installing
-------------------------
-
-Only dependency is C library with 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-2016, Tiiffi <tiiffi_at_gmail_dot_com>
+Copyright (c) 2012-2024, 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,4 @@ 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

@@ -1,31 +1,28 @@
-# if you want to cross compile
-# export PATH=$PATH:/path/to/compiler/bin
-# export CROSS_COMPILE=arm-none-linux-gnueabi-
-# make
+# if you want to cross compile:
+#   export PATH=$PATH:/path/to/compiler/bin
+#   export CROSS_COMPILE=arm-none-linux-gnueabi-
+#   make
+#
+# Windows cross compile:
+#   x86_64-w64-mingw32-gcc -std=gnu99 -Wall -Wextra -Wpedantic -O2 -fstack-protector-all -o mcrcon.exe mcrcon.c -lws2_32
 
 EXENAME = mcrcon
 PREFIX ?= /usr/local
 
-EXTRAFLAGS ?= -fstack-protector-strong
-
 INSTALL = install
 LINKER =
-RM = rm -f
+RM = rm -v -f
+
+CC ?= gcc
+CFLAGS = -std=gnu99 -Wall -Wextra -Wpedantic -Wno-gnu-zero-variadic-macro-arguments -O2
+EXTRAFLAGS ?= -fstack-protector-strong -D_FORTIFY_SOURCE=2 -fPIE -pie -Wl,-z,relro -Wl,-z,now -fno-common
 
 ifeq ($(OS), Windows_NT)
-    CC = gcc
 	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
-else
-	CFLAGS ?= -std=gnu99 -Wall -Wextra -Wpedantic -Os -s
-endif
-
 .PHONY: all
 all: $(EXENAME)
 
@@ -35,16 +32,16 @@ $(EXENAME): mcrcon.c
 ifneq ($(OS), Windows_NT)
 .PHONY: install
 install:
-	$(INSTALL) -vD $(EXENAME) $(PREFIX)/bin/$(EXENAME)
-	$(INSTALL) -vD -m 0644 mcrcon.1 $(PREFIX)/share/man/man1/mcrcon.1
+	$(INSTALL) -v $(EXENAME) $(DESTDIR)$(PREFIX)/bin/$(EXENAME)
+	$(INSTALL) -v -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 -f $(PREFIX)/bin/$(EXENAME) $(PREFIX)/share/man/man1/mcrcon.1
+	$(RM) $(DESTDIR)$(PREFIX)/bin/$(EXENAME) $(DESTDIR)$(PREFIX)/share/man/man1/mcrcon.1
 	@echo "\nmcrcon uninstalled.\n"
 endif
 
 .PHONY: clean
 clean:
-	$(RM) $(EXENAME)
+	$(RM) $(EXENAME) $(EXENAME).exe

README.md

@@ -1,70 +1,108 @@
-### Installing:
+# mcrcon
 
-from sources:
+mcrcon is a command-line [rcon](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) client intended for remote server administration and maintenance automation.
+
+Though originally developed for Minecraft servers, it also works with a variety of other servers using the Valve or Minecraft-style rcon protocol.
+
+
+---
+
+### Installing
+
+##### Binary releases
+
+Pre-built binaries are provided for Linux and Windows: https://github.com/Tiiffi/mcrcon/releases/latest
+
+##### Via package manager
+See https://pkgs.org/download/mcrcon and https://repology.org/project/mcrcon/packages for available packages in various Linux distros (note that some packages might be outdated).
+
+- Fedora: https://packages.fedoraproject.org/pkgs/mcrcon/mcrcon/
+- Gentoo: https://packages.gentoo.org/packages/games-util/mcrcon
+- Arch: https://aur.archlinux.org/packages/mcrcon/
+- NixOS: https://search.nixos.org/packages?show=mcrcon
+- Snapcraft: https://snapcraft.io/mcrcon-nsg
+- Scoop: https://scoop.sh/#/apps?q=mcrcon
+
+##### Building from sources
 ```sh
 git clone https://github.com/Tiiffi/mcrcon.git
 cd mcrcon
 make
+
+# install is optional
 sudo make install
 ```
-Check **INSTALL** 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>
+_Check [BUILDING.md](BUILDING.md) for more details._
 
 ---
 
-### Usage:
+### Usage
 mcrcon [OPTIONS] [COMMANDS]
 
 Sends rcon commands to Minecraft server.
 
 ```
 Option:
-  -h            Print usage
-  -H            Server address
-  -P            Port (default is 25575)
+  -H            Server address (default: localhost)
+  -P            Port (default: 25575)
   -p            Rcon password
-  -t            Interactive terminal mode
-  -s            Silent mode (do not print received packets)
+  -t            Terminal mode
+  -s            Silent mode
   -c            Disable colors
-  -r            Output raw packets (debugging and custom handling)
-  -v            Output version information
+  -r            Output raw packets
+  -w            Wait for specified duration (seconds) between each command (1 - 600s)
+  -h            Print usage
+  -v            Version information
 ```
-Commands with arguments must be enclosed in quotes.
-
 Server address, port and password can be set using following environment variables:
 ```
 MCRCON_HOST
 MCRCON_PORT
 MCRCON_PASS
 ```
-Note that command-line options will override environment variables.
+###### 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```
+###### Example:
+Send three commands ("say", "save-all", "stop") and wait five seconds between the commands:
+
+```sh
+mcrcon -H my.minecraft.server -p password -w 5 "say Server is restarting!" save-all stop
+```
+---
+
+> [!TIP]
+>Enable RCON on Minecraft server by adding following lines to [```server.properties```](https://minecraft.gamepedia.com/Server.properties) configuration file.
+>```
+>enable-rcon=true
+>rcon.port=25575
+>rcon.password=your_rcon_pasword
+>```
 
 ---
 
-### Enable rcon on server
-Remember to enable rcon by adding following lines to ```server.properties``` file.
-```
-enable-rcon=true
-rcon.port=25575
-rcon.password=your_rcon_pasword
-```
-
----
-
-#### Contact:
+### Contact
 
 * WWW:            https://github.com/Tiiffi/mcrcon/
-* MAIL:           tiiffi_at_gmail_dot_com
-* IRC:            tiiffi @ quakenet
-* BUG REPORTS:    https://github.com/Tiiffi/mcrcon/issues/
+* MAIL:           tiiffi+mcrcon at gmail
+* ISSUES:         https://github.com/Tiiffi/mcrcon/issues/
+
+> [!TIP]
+>When reporting issues, please provide the following information:
+>
+>- Version of mcrcon: Please specify the precise version number
+>- Game: Indicate the specific game server you're using (e.g., Minecraft, Valve Source Engine game, ARK, ...)
+>- Server version: Provide the exact version of the game server
+>- Mods and Extensions: List all mods and extensions used, including their versions
+>- Issue Description: Clearly describe the problem you're encountering and the expected behavior.
+>- Steps to reproduce
+>
+>If you're tech-savvy, consider providing a packet capture file (PCAP). Remember to use a fake password.
 
 ---
 
-<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)
+### License
+
+This project is licensed under the zlib License - see the [LICENSE](LICENSE) file for details.

create_shortcut.bat

@@ -0,0 +1,31 @@
+@echo off
+@cls
+
+@set /p host="Enter host (default: "127.0.0.1"): "
+@if "%host%"=="" set host=127.0.0.1
+
+@set /p port="Enter port (default: 25575): "
+@if "%port%"=="" set port=25575
+
+@set /p passwd="Enter password: "
+@if "%passwd%"=="" set passwd=
+
+set name=connect_%host%-%port%
+
+@set /p name="Enter shortcut name (default: "%name%.bat"): "
+@if "%name%"=="" set name=connect_%host%-%port%
+
+set command=@mcrcon.exe -t -H %host% -P %port% -p %passwd%
+
+@echo %command% >> %name%.bat
+@echo.
+@echo Command: "%command%"
+@echo.
+@echo Shortcut "%name%.bat" created!
+@echo.
+
+@set "host="
+@set "port="
+@set "passwd="
+
+@pause

launch.bat

@@ -0,0 +1,29 @@
+@echo off
+@cls
+
+@if not exist mcrcon.exe (
+  @echo ERROR: Cannot find "mcrcon.exe". Bailing out!
+  @echo.
+  @pause
+  @exit
+)
+
+@set /p host="Enter host (default: 127.0.0.1): "
+@if "%host%"=="" set host=127.0.0.1
+
+@set /p port="Enter port (default: 25575): "
+@if "%port%"=="" set port=25575
+
+@set /p passwd="Enter password: "
+@if "%passwd%"=="" set passwd=
+
+@echo.
+mcrcon.exe -t -H %host% -P %port% -p %passwd%
+@echo.
+
+@set "host="
+@set "port="
+@set "passwd="
+
+@pause
+

mcrcon.1

@@ -1,9 +1,9 @@
 .\" Process this file with
 .\" groff -man -Tascii mcrcon.1
 .\"
-.TH MCRCON 1 "December 2016" "Version 0.6.1"
+.TH MCRCON 1 "December 2024" "Version 0.8.0"
 .SH NAME 
-mcrcon \- sends rcon commands to a Minecraft server
+mcrcon \- send rcon commands to a Minecraft server
 .SH SYNOPSIS
 .B mcrcon [
 options
@@ -11,31 +11,34 @@ options
 commands
 .B ]
 .SH DESCRIPTION
-mcrcon is Minecraft rcon client / terminal with bukkit coloring support.
-It is well suited for remote administration and server maintenance scripts.
+mcrcon is a command-line rcon client intended for remote server administration and maintenance automation.
 .SH OPTIONS
-.IP -h
-Print usage
 .IP -H
-Server address
+Server address (default: localhost)
 .IP -P
-Port (default is 25575)
+Port (default: 25575)
 .IP -p
 Rcon password
 .IP -t
-Interactive terminal mode
+Terminal mode
 .IP -s
-Silent mode (do not print received packets)
+Silent mode
 .IP -c
 Disable colors
 .IP -r
-Output raw packets (for debugging and custom handling)
+Output raw packets
+.IP -w
+Wait for specified duration (seconds) between each command (1 - 600s)
+.IP -h
+Print usage
 .IP -v
 Output version information
 .PP
-Commands with arguments must be enclosed in quotes.
-.SH ENVIRONMENTAL VARIABLES
-Server address, port and password can be set using following environment variables:
+Commands with spaces must be enclosed in quotes.
+.br
+mcrcon will start in terminal mode if no commands are given.
+.SH ENVIRONMENT VARIABLES
+Server address, port and password can be set with following environment variables:
 .PP
 \fBMCRCON_HOST
 .br
@@ -55,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)
+Send three commands ("say", "save-all", "stop") and wait five seconds between the commands.
 .RS
-\fBmcrcon\fR -H my.minecraft.server -p password "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_at_gmail_dot_com\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