You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -28,50 +34,6 @@ A fully native RCON client implementation, zero third parties*
28
34
29
35

30
36
31
-
## Local Development
32
-
33
-
You can use the provided `Makefile` and `compose.yaml` to spin up a local development environment. This will start a Mordhau game server in a container.
34
-
35
-
### Prerequisites
36
-
37
-
- Docker and Docker Compose
38
-
- Go 1.22+
39
-
- Make (optional, but recommended)
40
-
41
-
### Getting Started
42
-
43
-
1.**Start a Game Server**:
44
-
45
-
Beware that the first time you build and run the server it might take a while for its RCON port to be usable, not sure why, but Rust one for example took a few minutes before it was responding, idk.
46
-
47
-
```bash
48
-
make lift-mh-server
49
-
```
50
-
51
-
or
52
-
53
-
```bash
54
-
make lift-rust-server
55
-
```
56
-
*Note: The server uses `network_mode: host` and may take a few minutes to fully initialize, make sure network_mode is supported by your docker engine*
57
-
58
-
2.**Build and Run the Client**:
59
-
```bash
60
-
make run
61
-
```
62
-
This will build the `tcprcon-cli` binary into `.out/` and execute it against the local server (see step 1) using the default development credentials.
63
-
64
-
3.**Run Tests**:
65
-
```bash
66
-
make test
67
-
```
68
-
69
-
4.**Dockerized Client**:
70
-
If you prefer to run the client itself inside a container:
71
-
```bash
72
-
make run-docker
73
-
```
74
-
75
37
## Features
76
38
77
39
-**Interactive Terminal UI**: full-screen exclusive TUI (like vim or nano) with command history and scrollable output
@@ -89,10 +51,53 @@ Linux binaries are available on the [releases page](https://github.com/UltimateF
89
51
90
52
### Docker
91
53
54
+
The Docker image is pulled automatically on first run, so no separate installation step is needed. Just run the container with your desired flags.
55
+
56
+
#### Basic Usage
57
+
58
+
All flags and commands from the main [Usage](#usage) section apply here—just prefix them with `docker run`. For example:
59
+
92
60
```bash
93
61
docker run -it ghcr.io/ultimateform/tcprcon-cli:latest --address=192.168.1.100 --port=7778
94
62
```
95
63
64
+
#### Persistent Configuration (Profiles)
65
+
66
+
**Note:**`tcprcon-cli` supports configuration profiles out of the box (see [Configuration Profiles](#configuration-profiles)). However, when using Docker, profiles are stored inside the container and lost when it exits. To persist profiles across container runs, use a Docker named volume:
@@ -228,6 +233,52 @@ While `tcprcon-cli` follows the standard Source RCON Protocol, some game servers
228
233
229
234
For a detailed breakdown of known server quirks and how they are handled, see the [Caveats section in the core library documentation](https://github.com/UltimateForm/tcprcon#caveats).
230
235
236
+
237
+
## Local Development
238
+
239
+
You can use the provided `Makefile` and `compose.yaml` to spin up a local development environment. This will start a Mordhau game server in a container.
240
+
241
+
### Prerequisites
242
+
243
+
- Docker and Docker Compose
244
+
- Go 1.22+
245
+
- Make (optional, but recommended)
246
+
247
+
### Getting Started
248
+
249
+
1.**Start a Game Server**:
250
+
251
+
Beware that the first time you build and run the server it might take a while for its RCON port to be usable, not sure why, but Rust one for example took a few minutes before it was responding, idk.
252
+
253
+
```bash
254
+
make lift-mh-server
255
+
```
256
+
257
+
or
258
+
259
+
```bash
260
+
make lift-rust-server
261
+
```
262
+
*Note: The server uses `network_mode: host` and may take a few minutes to fully initialize, make sure network_mode is supported by your docker engine*
263
+
264
+
2.**Build and Run the Client**:
265
+
```bash
266
+
make run
267
+
```
268
+
This will build the `tcprcon-cli` binary into `.out/` and execute it against the local server (see step 1) using the default development credentials.
269
+
270
+
3.**Run Tests**:
271
+
```bash
272
+
make test
273
+
```
274
+
275
+
4.**Dockerized Client**:
276
+
If you prefer to run the client itself inside a container:
0 commit comments