MCRCON(1)

πŸ“¦ version 0.7.2, in fedora 43, fedora 44

πŸ’– MCRCON β€” bestie edition πŸ’–

okay so real talk, this is mcrcon, the Gen Z Manual page (section 1, general commands, for the record) and it's literally just here to send rcon commands to a Minecraft server πŸŽ€ yes that's the whole vibe.


✨ SYNOPSIS ✨

mcrcon [ options ] [ commands ]

πŸ¦‹ DESCRIPTION πŸ¦‹

mcrcon is a Minecraft rcon client, bestie πŸ’… and it's not just for messing around in your world β€” it's built for remote administration and for server maintenance scripts. so like, actual sysadmin main character energy, no cap πŸ‘‘


🌸 OPTIONS 🌸

  • -H β€” the server address. default is localhost, so if you're hanging out on your own machine you don't even gotta say it πŸ’œ
  • -P β€” the port. default is 25575 πŸ“
  • -p β€” the rcon password πŸ”
  • -t β€” terminal mode πŸ–₯️
  • -s β€” silent mode 🀫
  • -c β€” disable colors 🌈 (sad but okay)
  • -r β€” output raw packets πŸ“¦ like, unprocessed, straight up
  • -w β€” wait for the specified duration, in seconds, between each command. the range is 1 - 600s ⏳
  • -h β€” print usage πŸ“–
  • -v β€” output version information πŸ‘‘
lowkey important: commands with spaces must be enclosed in quotes, fr fr. "like this" ✨
also!! mcrcon will start in terminal mode if no commands are given. so if you just wanna vibe in there interactively, don't pass any commands πŸ’…

πŸ’œ ENVIRONMENT VARIABLES πŸ’œ

the server address, the port, and the password can all be set with these environment variables, so you don't have to type them every single time:

  • MCRCON_HOST
  • MCRCON_PORT
  • MCRCON_PASS
ngl there's a catch: command-line options will override environment variables. the CLI always wins, periodt πŸ‘‘

🧚 EXAMPLES 🧚

make an rcon connection in terminal mode using the default port

mcrcon -H my.minecraft.server -p password

send the "weather clear" command to the server using custom port 1337

mcrcon -H my.minecraft.server -P 1337 -p password "weather clear"

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

look at that last one β€” it's giving automation, it's giving graceful restart, it ate πŸ’…βœ¨


😭 BUGS 😭

found a bug? don't suffer in silence bestie, report it to tiiffi+mcrcon at gmail or right here: https://github.com/Tiiffi/mcrcon/issues/ 🫢


okay that's the whole page!! Version 0.7.2, from October 2021 β€” thanks for reading, ily, go restart your server responsibly πŸŒΈπŸ’–πŸ¦‹

πŸ“¦ where this page comes from