Compare commits

...

3 Commits

Author SHA1 Message Date
dd1d530d44 add img/ 2024-11-04 22:01:01 +00:00
f2752f5609 print usage message if not in interactive mode, and no rcon commands passed 2024-11-04 21:23:45 +00:00
05ee3f1912 reword 2024-11-04 17:46:11 +00:00
4 changed files with 23 additions and 5 deletions

View File

@ -54,7 +54,9 @@ func main() {
#### `WithLoginTimeout(timeout time.Duration)`
If the server was just started or is currently performing a long operation like map rotating then it's possible to receive empty rcon responses. In which case you'll want to retry login. Use this functional option to set the max timeout for logins, it defaults to 5 seconds. For example:
If the server was just started or is currently performing a long operation like map rotating then it's possible to receive empty rcon responses. In which case you'll want to retry login. Use this functional option to set the max timeout for logins, it defaults to 5 seconds.
For example:
```go
rcon, err := q3rcon.New(
@ -64,7 +66,7 @@ rcon, err := q3rcon.New(
#### `WithDefaultTimeout(timeout time.Duration)`
You may want to change the default timeout if some of your responses are getting mixed together (stability can depend on connection to the server). For example, on LAN I can leave the default at 20ms, when connecting remotely I normally increase this to 50ms.
You may want to change the default timeout if some of your responses are getting mixed together (stability can depend on connection to the server). For example, over localhost I can leave the default at 20ms, when connecting remotely I normally increase this to 50ms.
For example:
@ -115,10 +117,15 @@ If interactive mode is enabled, any arguments sent on the command line will be i
## Your own implementation
I've separated the q3rcon package from the CLI precisely so that you can write your own implementation, since I don't know the target game or it's commands. For example, in my case I've added terminal colouring and reformatted some of the command responses.
The included CLI is a generic implementation, while it can be used out of the box you may find that some requests result in fragmented responses. The solution is to implement your own version, adjusting the timings with the functional options as detailed above. I could have increased the default timeouts but that would add unnecessary delay for most requests, so I decided to leave those details to the users of the package.
Since you can include the q3rcon package into your own package you can easily make your own modifications, for example, I added [colour to the terminal][status] and [reformatted some of the responses][mapname].
## Logging
Log level may be set by passing the `-l` flag with a number from 0 up to 6 where
0 = Panic, 1 = Fatal, 2 = Error, 3 = Warning, 4 = Info, 5 = Debug, 6 = Trace
[status]: ./img/status.png
[mapname]: ./img/mapname.png

View File

@ -2,6 +2,7 @@ package main
import (
"bufio"
"errors"
"flag"
"fmt"
"io"
@ -16,6 +17,12 @@ import (
var interactive bool
func exit(err error) {
_, _ = fmt.Fprintf(os.Stderr, "Error: %s\n", err)
flag.Usage()
os.Exit(1)
}
func main() {
var (
host string
@ -57,6 +64,11 @@ func main() {
return
}
if len(flag.Args()) == 0 {
err = errors.New("no rcon commands passed")
exit(err)
}
for _, arg := range flag.Args() {
resp, err := rcon.Send(arg)
if err != nil {
@ -68,8 +80,7 @@ func main() {
}
func connectRcon(host string, port int, password string) (*q3rcon.Rcon, error) {
rcon, err := q3rcon.New(
host, port, password)
rcon, err := q3rcon.New(host, port, password)
if err != nil {
return nil, err
}

BIN
img/mapname.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

BIN
img/status.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB