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

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,13 +1,21 @@
 #### Version history:
 
-###### 0.7.3
+###### 0.8.0
- - Add support to Valve style rcon authentication
+ - 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
+    * 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

INSTALL.md

@@ -1,22 +0,0 @@
-Building and installing
------------------------
-
-Only dependency is C library and POSIX getopt support. 
-
-Compiling with GCC or CLANG:
-
-    cc -std=gnu99 -Wpedantic -Wall -Wextra -O2 -o mcrcon mcrcon.c
-    
-Note: on Windows remember to link with winsock 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.

Makefile

@@ -13,9 +13,9 @@ INSTALL = install
 LINKER =
 RM = rm -v -f
 
-CC = gcc
+CC ?= gcc
-CFLAGS = -std=gnu99 -Wall -Wextra -Wpedantic -O2
+CFLAGS = -std=gnu99 -Wall -Wextra -Wpedantic -Wno-gnu-zero-variadic-macro-arguments -O2
-EXTRAFLAGS ?= -fstack-protector-all
+EXTRAFLAGS ?= -fstack-protector-strong -D_FORTIFY_SOURCE=2 -fPIE -pie -Wl,-z,relro -Wl,-z,now -fno-common
 
 ifeq ($(OS), Windows_NT)
 	LINKER = -lws2_32
@@ -44,4 +44,4 @@ endif
 
 .PHONY: clean
 clean:
-	$(RM) $(EXENAME)
+	$(RM) $(EXENAME) $(EXENAME).exe

README.md

@@ -1,6 +1,9 @@
 # mcrcon
 
-mcrcon is console based Minecraft [rcon](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) client for remote administration and server maintenance scripts.
+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.
+
 
 ---
 
@@ -29,7 +32,7 @@ make
 # install is optional
 sudo make install
 ```
-Check [INSTALL.md](INSTALL.md) for more details.
+_Check [BUILDING.md](BUILDING.md) for more details._
 
 ---
 
@@ -68,17 +71,15 @@ Send three commands ("say", "save-all", "stop") and wait five seconds between th
 ```sh
 mcrcon -H my.minecraft.server -p password -w 5 "say Server is restarting!" save-all stop
 ```
-
 ---
 
-##### How to enable rcon on a Minecraft Server 
+> [!TIP]
-
+>Enable RCON on Minecraft server by adding following lines to [```server.properties```](https://minecraft.gamepedia.com/Server.properties) configuration file.
-Enable rcon by adding following lines to [```server.properties```](https://minecraft.gamepedia.com/Server.properties) configuration file.
+>```
-```
+>enable-rcon=true
-enable-rcon=true
+>rcon.port=25575
-rcon.port=25575
+>rcon.password=your_rcon_pasword
-rcon.password=your_rcon_pasword
+>```
-```
 
 ---
 
@@ -88,16 +89,17 @@ rcon.password=your_rcon_pasword
 * MAIL:           tiiffi+mcrcon at gmail
 * ISSUES:         https://github.com/Tiiffi/mcrcon/issues/
 
-When reporting issues, please provide the following information:
+> [!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, ...)
+>- Version of mcrcon: Please specify the precise version number
-- Server version: Provide the exact version of the game server
+>- Game: Indicate the specific game server you're using (e.g., Minecraft, Valve Source Engine game, ARK, ...)
-- Mods and Extensions: List all mods and extensions used, including their versions
+>- Server version: Provide the exact version of the game server
-- Issue Description: Clearly describe the problem you're encountering and the expected behavior.
+>- Mods and Extensions: List all mods and extensions used, including their versions
-- Steps to reproduce
+>- 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.
+>
+>If you're tech-savvy, consider providing a packet capture file (PCAP). Remember to use a fake password.
 
 ---
 

mcrcon.1

@@ -1,7 +1,7 @@
 .\" Process this file with
 .\" groff -man -Tascii mcrcon.1
 .\"
-.TH MCRCON 1 "November 2024" "Version 0.7.3"
+.TH MCRCON 1 "December 2024" "Version 0.8.0"
 .SH NAME 
 mcrcon \- send rcon commands to a Minecraft server
 .SH SYNOPSIS
@@ -11,7 +11,7 @@ options
 commands
 .B ]
 .SH DESCRIPTION
-mcrcon is Minecraft rcon client 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
 Server address (default: localhost)