mirror of
https://github.com/Tiiffi/mcrcon.git
synced 2025-10-27 11:21:07 -04:00
Compare commits
90 Commits
v0.6.2-dev
...
4a1da8d373
| Author | SHA1 | Date | |
|---|---|---|---|
| 4a1da8d373 | |||
| b1b46ca08c | |||
| 2bb1fafdaa | |||
| 0fb17971c0 | |||
| ec11d77e89 | |||
| 2d29741691 | |||
| cc77044df1 | |||
| dba07aacf7 | |||
| bd76b897de | |||
| 1106f27700 | |||
| 00fc3b5bcb | |||
| a0fe9e1645 | |||
| 5f460e8912 | |||
| 6fed74ba74 | |||
| 5d1c87b26f | |||
| fd77ad7fc0 | |||
| bc5617407d | |||
| 5ae06f4d37 | |||
| 233031cdcb | |||
| ebf5172cd0 | |||
| 0b72e4d17d | |||
| af70f87bc1 | |||
| 53fd703911 | |||
| c0d28bcb17 | |||
| edf8344983 | |||
| a502204e26 | |||
| 7162bc6fe6 | |||
| f270a485b5 | |||
| df66816bee | |||
| 5c7ab407d7 | |||
| c83d96cc91 | |||
| 427fd206ca | |||
| 1a4010cbba | |||
| 4488127350 | |||
| 6b563df23d | |||
| 5a2dcf41ac | |||
| 7d3f3c1d61 | |||
| fc040ce5ea | |||
| 489306d4a2 | |||
| a8e2a9349e | |||
| deed43ad61 | |||
| aa933d2c1f | |||
| accae57e4b | |||
| fa25cde79c | |||
| e96b2eff6e | |||
| b5951e9634 | |||
| 7b8ea2bf39 | |||
| 05aaff88d4 | |||
| fca278e092 | |||
| b3147ebe43 | |||
| 48c065c304 | |||
| 29a1c99f82 | |||
| bf11460a0d | |||
| 3e8acd5e42 | |||
| ada14bb4d9 | |||
| 336f528668 | |||
| 58a7a86bc3 | |||
| b02201d689 | |||
| 4cff2fe537 | |||
| 0d11c6a4e9 | |||
| 9c68d9cdd4 | |||
| 6d49968df3 | |||
| b118b7b7b9 | |||
| 253fb70a72 | |||
| f351fb134e | |||
| af5e88b528 | |||
| 83cdaae362 | |||
| 876201fe5a | |||
| 3c071c0c45 | |||
| d2ebbd8f12 | |||
| cffa73d223 | |||
| c62d5c8a70 | |||
| 8b75ddf4bf | |||
| 4f3a455095 | |||
| 5fb20c2b83 | |||
| 0c48fbb847 | |||
| fcc9d6d09b | |||
| 018592abc5 | |||
| de926b8c26 | |||
| 0f796b6bbc | |||
| f9d9a02348 | |||
| a8863e1fcc | |||
| 83457075b9 | |||
| 2f1f925ac1 | |||
| 8ff710e231 | |||
| 7737bc2a32 | |||
| 52e717a92b | |||
| 8fdda295e2 | |||
| 0b1853dccc | |||
| d338537e23 |
20
.travis.yml
20
.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
|
||||
29
BUILDING.md
Normal file
29
BUILDING.md
Normal file
@ -0,0 +1,29 @@
|
||||
Building and installing
|
||||
-----------------------
|
||||
|
||||
#### Requirements & dependencies:
|
||||
- GCC compatible compiler
|
||||
- POSIX getopt support from **<unistd.h>**
|
||||
|
||||
---
|
||||
|
||||
#### 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.
|
||||
30
CHANGELOG.md
30
CHANGELOG.md
@ -1,5 +1,35 @@
|
||||
#### 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
|
||||
|
||||
|
||||
22
INSTALL.md
22
INSTALL.md
@ -1,22 +0,0 @@
|
||||
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.
|
||||
3
LICENSE
3
LICENSE
@ -1,4 +1,4 @@
|
||||
Copyright (c) 2012-2019, Tiiffi <tiiffi at gmail>
|
||||
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
|
||||
@ -18,4 +18,3 @@ freely, subject to the following restrictions:
|
||||
|
||||
3. This notice may not be removed or altered from any source
|
||||
distribution.
|
||||
|
||||
28
Makefile
28
Makefile
@ -1,7 +1,10 @@
|
||||
# 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
|
||||
@ -10,9 +13,9 @@ INSTALL = install
|
||||
LINKER =
|
||||
RM = rm -v -f
|
||||
|
||||
CC = cc
|
||||
CFLAGS = -std=gnu99 -Wall -Wextra -Wpedantic -Os -s
|
||||
EXTRAFLAGS ?= -fstack-protector-strong
|
||||
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)
|
||||
LINKER = -lws2_32
|
||||
@ -20,11 +23,6 @@ ifeq ($(OS), Windows_NT)
|
||||
RM = cmd /C del /F
|
||||
endif
|
||||
|
||||
ifeq ($(shell uname), Darwin)
|
||||
INSTALL = ginstall
|
||||
CFLAGS = -std=gnu99 -Wall -Wextra -Wpedantic -Os
|
||||
endif
|
||||
|
||||
.PHONY: all
|
||||
all: $(EXENAME)
|
||||
|
||||
@ -34,8 +32,8 @@ $(EXENAME): mcrcon.c
|
||||
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
|
||||
$(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
|
||||
@ -46,4 +44,4 @@ endif
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
$(RM) $(EXENAME)
|
||||
$(RM) $(EXENAME) $(EXENAME).exe
|
||||
|
||||
88
README.md
88
README.md
@ -1,33 +1,42 @@
|
||||
# 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.
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Installing:
|
||||
### Installing
|
||||
|
||||
##### via packet manager:
|
||||
See https://pkgs.org/download/mcrcon for available packages in various Linux distros.
|
||||
##### Binary releases
|
||||
|
||||
- Gentoo Linux: https://packages.gentoo.org/packages/games-util/mcrcon
|
||||
- Arch Linux: https://aur.archlinux.org/packages/mcrcon/
|
||||
Pre-built binaries are provided for Linux and Windows: https://github.com/Tiiffi/mcrcon/releases/latest
|
||||
|
||||
##### from sources:
|
||||
##### 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.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>
|
||||
_Check [BUILDING.md](BUILDING.md) for more details._
|
||||
|
||||
---
|
||||
|
||||
### Usage:
|
||||
### Usage
|
||||
mcrcon [OPTIONS] [COMMANDS]
|
||||
|
||||
Sends rcon commands to Minecraft server.
|
||||
@ -41,9 +50,9 @@ Option:
|
||||
-s Silent mode
|
||||
-c Disable colors
|
||||
-r Output raw packets
|
||||
-w Wait for specified duration (seconds) between each command (1 - 600s)
|
||||
-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:
|
||||
```
|
||||
@ -56,35 +65,44 @@ MCRCON_PASS
|
||||
- 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```](https://minecraft.gamepedia.com/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
|
||||
* 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.
|
||||
|
||||
---
|
||||
|
||||
### License
|
||||
|
||||
This project is licensed under the zlib License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
---
|
||||
|
||||
<sub>Master:</sub> 
|
||||
<sub>Develop:</sub> 
|
||||
|
||||
31
create_shortcut.bat
Normal file
31
create_shortcut.bat
Normal file
@ -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
|
||||
29
launch.bat
Normal file
29
launch.bat
Normal file
@ -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
|
||||
|
||||
16
mcrcon.1
16
mcrcon.1
@ -1,7 +1,7 @@
|
||||
.\" Process this file with
|
||||
.\" groff -man -Tascii mcrcon.1
|
||||
.\"
|
||||
.TH MCRCON 1 "October 2019" "Version 0.6.2"
|
||||
.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)
|
||||
@ -27,17 +27,17 @@ Silent mode
|
||||
Disable colors
|
||||
.IP -r
|
||||
Output raw packets
|
||||
.IP -w
|
||||
Wait for specified duration (seconds) between each command (1 - 600s)
|
||||
.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
|
||||
.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
|
||||
|
||||
Reference in New Issue
Block a user