mirror of
https://github.com/hamburghammer/rcon.git
synced 2024-12-23 00:07:41 +01:00
39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
|
# rcon
|
||
|
|
A go written library for the [RCON Protocol](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol).
|
||
|
|
|
||
|
|
This is a fork from [james4k/rcon](https://github.com/james4k/rcon) with the support for go modules and with a rework of the original implementation for better readability.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
```golang
|
||
|
|
// Espablish a connection.
|
||
|
|
remoteConsole, err := rcon.Dial("127.0.0.1", "password")
|
||
|
|
if err != nil {
|
||
|
|
fmt.Println(err)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Send a command.
|
||
|
|
requestID, err := remoteConsole.Write("command")
|
||
|
|
if err != nil {
|
||
|
|
fmt.Println(err)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Read the response
|
||
|
|
response, responseID, err := remoteConsole.Read()
|
||
|
|
if err != nil {
|
||
|
|
fmt.Println(err)
|
||
|
|
}
|
||
|
|
if requestID != responseID {
|
||
|
|
fmt.Println("response id doesn't match the request id!")
|
||
|
|
}
|
||
|
|
|
||
|
|
fmt.Println(response)
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
This lib is licesed under the [MIT License](LICENSE)
|
||
|
|
|
||
|
|
## Contributors
|
||
|
|
If you should encaunter a bug or a missing feature dont hessitate to open an issue or even submit a pull-request.
|
||
|
|
|
||
|
|
|
||
|
|
Special thx to [nhh](https://github.com/nhh) and [dnltinney](https://github.com/dnltinney) for the great help debugging this lib.
|