Northstar RCON Client

This is a small, cross-platform implementation of an RCON client for the Northstar mod, as it's implemented in the RCON PR.

There are two things in this repo:

northstar-rcon-client, a Rust library that provides an async RCON client with Tokio.
northstar-rcon-cli, a portable command-line RCON client implemented with the library.

Usage

USAGE:
    northstar-rcon-cli.exe [OPTIONS] <ADDRESS>

ARGS:
    <ADDRESS>    Address of the Northstar server, e.g. `127.0.0.1:37015`

OPTIONS:
    -h, --help                     Print help information
    -n, --name <NAME>              Name to display for the server in the prompt
    -p, --pass-file <PASS_FILE>    Authenticate automatically with a password in a file
        --script-mode              Force non-interactive script mode, even in interactive terminals
    -V, --version                  Print version information

Make sure you have RCON running on a dedicated server, as per the instructions in the PR.

Connect by passing the address to the server to the CLI executable. The port is optional, and will default to 37015.

You will be prompted for a password. Enter the one set in the rcon_password ConVar on the server.

Once connected, any command will be sent and run on the server. There are also several builtin commands, which are interpreted by the client:

BUILTINS:
    !help                   View this help listing
    !enable console         Enable server console logging
    !quit                   Quit this session
    !set <VAR> <VAL>        Set a ConVar on the server
    <COMMAND> [ARGS...]     Run a command on the server

Logs sent from the server will be printed on the client. This is disabled by default on the server, but can be enabled by setting the sv_rcon_sendlogs ConVar to 1 or running the !enable console builtin.

Building

Use rustup to install a Rust toolchain, if you don't have one already.
Run cargo build --release in this repo.
After it's built, command-line client will be at target/release/northstar-rcon-cli.

License

Provided under the MIT license. See the LICENSE file for details.

Releases(v0.2.1)

v0.2.1(Aug 8, 2022)
northstar-rcon-cli

Fix invalid password auth response not being handled correctly (#1)

northstar-rcon-client

Expose inner error types and error messages in crate Error type

Source code(tar.gz)
Source code(zip)
nsrcon-linux64(882.35 KB)
nsrcon-macos64(764.32 KB)
nsrcon-win64.exe(667.00 KB)
v0.2.0(Aug 3, 2022)

Tested with RCON PR up to https://github.com/Mauler125/NorthstarLauncher/commit/5d9bbd0b9dcb711b64c182ce666a6f7d4a86c8f3.
Source code(tar.gz)
Source code(zip)
nsrcon-linux64(1.53 MB)
nsrcon-macos64(1.36 MB)
nsrcon-win64.exe(1.40 MB)