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

Moved changelog and compiling to own files and updated usage info in README.md.

Browse Source
This commit is contained in:
Tiiffi
2016-11-15 20:41:58 +02:00
parent a0e638edc9
commit 46af96a3a4
3 changed files with 92 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
CHANGELOG.md Normal file
View File

@ -0,0 +1,64 @@
####Version history:
######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.
####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)

11
COMPILING Normal file
View File

@ -0,0 +1,11 @@
####Compiling:
Compile with GCC or CLANG:
```cc -std=gnu11 -Wpedantic -Wall -Wextra -O2 -s -o mcrcon mcrcon.c```
or just run **make**.
On windows, remember to link with winsockets.
Add ```-lws2_32``` to compiler command line on Mingw GCC.
---

110
README.md
View File

@ -1,38 +1,28 @@
####Compiling:
Compile with GCC or CLANG:
```cc -std=gnu11 -Wpedantic -Wall -Wextra -O2 -s -o mcrcon mcrcon.c```
or just run **make**.
On windows, remember to link with winsockets.
Add ```-lws2_32``` to compiler command line on Mingw GCC.
---
####Usage: ####Usage:
Usage: mcrcon [OPTIONS]... [COMMANDS]... Usage: mcrcon [OPTIONS]... [COMMANDS]...
Sends rcon commands to minecraft server.
Sends rcon commands to Minecraft server.
``` ```
Option: Option:
-h Print usage. -h Print usage
-s Silent mode. Do not print data received from rcon. -H Server address
-t Terminal mode. Acts as interactive terminal. -P Port (default is 25575)
-p Rcon password. Default: "". -p Rcon password
-H Host address or ip. -t Interactive terminal mode
-P Port. Default: 25575. -s Silent mode (do not print received packets)
-c Disable colors. -c Disable colors
-r Output raw packets. -r Output raw packets (debugging and custom handling)
Good for debugging and custom handling of the output. -v Output version information
``` ```
Commands must be separated with spaces.
Commands with arguments must enclosed in quotes.
Example: Example:
```mcrcon -c -H 192.168.1.42 -P 25575 -p password cmd1 "cmd2 arg1 arg2"``` ```mcrcon -H my.minecraft.server -p password "say Server is restarting!" save-all stop```
#####Enable server rcon #####Enable rcon on server
Remember to enable rcon by changing / adding following lines in ```server.properties``` file. Remember to enable rcon by changing or adding following lines in ```server.properties``` file.
``` ```
enable-rcon=true enable-rcon=true
rcon.port=25575 rcon.port=25575
@ -43,74 +33,8 @@ rcon.password=your_rcon_pasword
####Contact: ####Contact:
* WWW: http://sourceforge.net/projects/mcrcon/ * WWW: https://github.com/Tiiffi/mcrcon/
* MAIL: tiiffi_at_gmail_dot_com * MAIL: tiiffi_at_gmail_dot_com
* IRC: tiiffi @ quakenet * IRC: tiiffi @ quakenet
* BUG REPORTS: https://github.com/Tiiffi/mcrcon/issues/ * BUG REPORTS: https://github.com/Tiiffi/mcrcon/issues/
---
####Version history:
######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.
####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)