https://github.com/Tiiffi/mcrcon
Rcon client for Minecraft
https://github.com/Tiiffi/mcrcon
administration game-server linux maintenance-script maintenance-scripts maintenance-terminal maintenance-tool mcrcon minecraft mojang rcon rcon-client remote-access remote-admin remote-admin-tool remote-administration-tool remote-administrator-tool remote-control source-rcon valve-rcon
Last synced: about 1 month ago
JSON representation
Rcon client for Minecraft
- Host: GitHub
- URL: https://github.com/Tiiffi/mcrcon
- Owner: Tiiffi
- License: zlib
- Created: 2013-06-19T02:03:39.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-12-02T05:37:27.000Z (4 months ago)
- Last Synced: 2024-12-02T06:26:59.312Z (4 months ago)
- Topics: administration, game-server, linux, maintenance-script, maintenance-scripts, maintenance-terminal, maintenance-tool, mcrcon, minecraft, mojang, rcon, rcon-client, remote-access, remote-admin, remote-admin-tool, remote-administration-tool, remote-administrator-tool, remote-control, source-rcon, valve-rcon
- Language: C
- Homepage: https://github.com/Tiiffi/mcrcon/
- Size: 129 KB
- Stars: 856
- Watchers: 24
- Forks: 117
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-docker - Tiiffi/mcrcon
- awesome-docker - Tiiffi/mcrcon
README
# mcrcon
mcrcon is console based Minecraft [rcon](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) client for remote administration and server maintenance scripts.
---
### Installing:
##### via packet manager:
See https://pkgs.org/download/mcrcon for available packages in various Linux distros (note that available packages might be outdated).
- Gentoo Linux: https://packages.gentoo.org/packages/games-util/mcrcon
- Arch Linux: https://aur.archlinux.org/packages/mcrcon/
##### building 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.
Precompiled binaries (if provided)*: https://github.com/Tiiffi/mcrcon/releases/latest
*At the moment binaries are provided for Linux and Windows.
---
### 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
-w Wait for specified duration (seconds) between each command (1 - 600s)
-h Print usage
-v Version information
```
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:
> Send three commands ("say", "save-all", "stop") and wait five seconds between the commands.
```mcrcon -H my.minecraft.server -p password -w 5 "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+mcrcon at gmail
* BUG REPORTS: https://github.com/Tiiffi/mcrcon/issues/
---
### License
This project is licensed under the zlib License - see the [LICENSE](LICENSE) file for details.
---
Master: 
Develop: 