mctl
mctl is a terminal-friendly remote console client
Index
Installation
Install mctl using golang
go install code.jakeyoungdev.com/jake/mctl@main
Use
Configuring mctl
mctl requires a one-time setup via the 'init' command before using any other commands
mctl init
Add a server
A
Connecting to server
Once the client has been configured commands can be sent to the server using the 'login' command. This will authenticate you with the game server and enter the command loop, the session is logged out when the command loop is broken
mctl login #makes auth request to server with saved password
Sending commands
If login is successful the app will enter the command loop, which allows commands to be sent directly to the server. Commands are sent as-is to the server, there is no validation of command syntax within mctl
Logging into X.X.X.X on port 61695
Connected! Type 'mctl' to close
RCON@X.X.X.X /> list
There are 0 of a max of 20 players online:
Saving commands
Commands can be saved under an alias for quick execution later, saved commands can contain placeholders '%s' that can be populated at runtime to allow for commands with unique runtime args to still be saved, see example for more:
mctl save <name>
Viewing commands
Saved commands can be viewed with:
mctl view <name>
All saved commands can be viewed with:
mctl view all
Running saved commands
Commands that have been saved can be run with:
mctl run <name>
If the saved command contains placeholders, the necessary arguments must be supplied:
mctl run <name> args...
Saving and running example
#saving command named "test" to run "tp %s 0 0 0"
mctl save test
Command: tp %s 0 0 0
#run command on user "jake"
mctl run test jake
#will run: tp jake 0 0 0 on remote server
Delete saved command
Commands can be deleted with:
mctl delete <name>
Clear configuration file
To clear all fields from the configuration file use:
#CAUTION: If the config file is cleared all data previously saved will be lost forever
mctl clear
Security
RCon is an inherently insecure protocol, passwords are sent in plaintext and, if possible, the port should not be exposed to the internet. It is best to keep these connections local or over a VPN.
mctl utilizes govulncheck and gosec in workflows to ensure quality, secure code is being pushed. These workflow steps must pass before a PR will be accepted
Development
this repo is currently in development and may encounter breaking changes, use a tag to prevent any surprises
TODO
- update readme, the commands are all broken
- Maybe move off of fmt