outdead/rcon

rcon-cli

通过RCON协议在远程Source专用游戏服务器上执行查询的命令行工具。

支持的游戏

• Project Zomboid
• Conan Exiles
• Rust（启动服务器时需在参数中添加 +rcon.web 0，或在 rcon-cli 参数中添加 -t web）
• ARK: Survival Evolved
• 7 Days to Die（需在 rcon-cli 参数中添加 -t telnet）

如果您成功将此工具用于其他支持RCON的游戏，欢迎提交拉取请求并添加到列表中。

安装

从 https://github.com/gorcon/rcon-cli/releases/latest 下载适用于您平台的二进制文件。

发布详情请参见 更新日志。

Docker

bash
docker pull outdead/rcon

使用方法

text
使用方法:
   rcon [选项] [命令...]

全局选项:
   --address value, -a value   设置远程服务器的主机和端口，例如 127.0.0.1:16260
   --password value, -p value  设置远程服务器的密码
   --type value, -t value      指定连接类型（默认: rcon）
   --log value, -l value       日志文件路径，若未指定则从配置文件获取
   --config value, -c value    配置文件路径（默认: rcon.yaml）
   --env value, -e value       包含服务器凭据的配置环境（默认: default）
   --help, -h                  显示帮助信息（默认: false）
   --version, -v               打印版本信息（默认: false）

rcon-cli 支持两种运行模式：单查询模式和交互输入流模式。

单命令模式

启动时需通过标志指定服务器地址、密码和命令。示例：

bash
./rcon -a 127.0.0.1:16260 -p mypassword command

从 rcon-cli 0.9.0 版本开始，支持在一个请求中发送多个命令。示例：

bash
./rcon -a 127.0.0.1:16260 -p mypassword command "包含多个单词的命令" '包含"双引号"的命令'

若传入命令，工具将以单命令模式运行，显示响应后退出。

交互输入流模式

不带命令运行 rcon 即可进入交互模式。示例：

bash
./rcon -a 127.0.0.1:16260 -p mypassword

使用 ^C 终止或输入命令 :q 退出。

配置文件

为方便使用，支持创建 rcon.yaml 配置文件，可保存远程服务器的主机、端口和密码。若配置文件存在且默认环境块已填写，启动时可省略 -a 和 -p 标志。示例：

bash
./rcon -a 127.0.0.1:16260 players
./rcon status
./rcon -p mypassword
./rcon

默认配置文件名为 rcon.yaml，需采用 YAML 格式。还可设置环境名称及各服务器的连接参数，并为每个服务器单独定义日志文件路径（若未指定日志路径则不记录日志）。

yaml
default:
  address: "127.0.0.1:16260"
  password: "password"
  log: "rcon-default.log"
zomboid:
  address: "127.0.0.1:16260"
  password: "password"
  log: "rcon-zomboid.log"
rust:
  address: "127.0.0.1:28003"
  password: "password"
7dtd:
  address: "172.19.0.2:8081"
  password: "password"
  type: "telnet"

可在启动时指定环境：

bash
./rcon -e rust status
./rcon -e zomboid

也可指定自定义配置文件：

bash
./rcon -c /path/to/config/file.yaml

使用 -l 参数指定日志文件路径：

bash
./rcon -l /path/to/file.log

从 rcon-cli 0.7.0 版本开始支持 TELNET 协议（7 Days to Die 控制台远程访问基于此协议），可通过 -t telnet 参数指定协议类型：

bash
./rcon -a 172.19.0.2:8081 -p password -t telnet version

从 rcon-cli 0.8.0 版本开始支持 Web RCON 协议（Rust 控制台远程访问基于此协议），可通过 -t web 参数指定协议类型：

bash
./rcon -a 127.0.0.1:28016 -p password -t web status

贡献

若您发现 bug，请创建 issue 并说明您的操作系统、平台、复现问题的游戏，以及详细的操作步骤以便复现。

许可证

MIT 许可证，详见 LICENSE