From 9f807041e50d74dbda7851406a0ac13e06064e07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Vieira?= Date: Mon, 27 May 2019 14:40:45 +0200 Subject: [PATCH] Adds config file information on readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 960056c..1f7a451 100644 --- a/README.md +++ b/README.md @@ -35,3 +35,16 @@ Flags: --password string RCON server's password --port int Server's RCON port (default 27015) ``` + +## Configuration + +You can preconfigure rcon-cli to use the arguments you want by default by modifying the file `.rcon-cli.yaml` in your home folder. If you want to use any other file use the argument `--config /path/to/the/config.yaml`. + +Example of a `.rcon-cli.yaml` file: +```yaml +host: mydomain.com +port: 12345 +password: mycustompassword +``` + +That way executing `rcon-cli` without arguments would connect to `mydomain.com:12345` with the password `mycustompassword` by default.