hamburghammer-mirrors/grcon
1
0
Fork 0
mirror of https://github.com/hamburghammer/grcon.git synced 2024-12-23 05:27:42 +01:00
Code Issues Projects Releases Wiki Activity
No description
1 commit 1 branch 2 tags 55 KiB
Go 100%
Find a file
Augusto Dwenger J 1cda9ca591
Init commit 
Initially it was the idea that this would be version 2 of the
https://github.com/hamburghammer/rcon lib but I changed my mind and
decided to make a new Project out of it.
It has formally nothing to do with the original lib.
2022-02-17 22:33:58 +01:00
client Init commit 2022-02-17 22:33:58 +01:00
util Init commit 2022-02-17 22:33:58 +01:00
.drone.yml Init commit 2022-02-17 22:33:58 +01:00
.gitignore Init commit 2022-02-17 22:33:58 +01:00
errors.go Init commit 2022-02-17 22:33:58 +01:00
go.mod Init commit 2022-02-17 22:33:58 +01:00
grcon.go Init commit 2022-02-17 22:33:58 +01:00
grcon_examples_test.go Init commit 2022-02-17 22:33:58 +01:00
grcon_test.go Init commit 2022-02-17 22:33:58 +01:00
LICENSE Init commit 2022-02-17 22:33:58 +01:00
README.md Init commit 2022-02-17 22:33:58 +01:00
size.go Init commit 2022-02-17 22:33:58 +01:00
types.go Init commit 2022-02-17 22:33:58 +01:00

README.md

grcon

A basic Golang library for the RCON Protocol.

Features

  • Max control over the underlying connection.
  • Works on a slow internet connection.
  • Stable, reliable and tested implementation.
  • Small API surface.
  • Simple and powerfully error type system.
  • Good documented.
  • Offering different levels of abstraction.

Structure

Small overview of the structure and most important files.

Main

Inside the "main" package you will find the low-level implementation of the grcon Protocol. The starting point to get into it is the grcon.go File.

Util

This is the location for helper functions. It is a collection to facilitate the interaction with Packets and RemoteConsole.

Client

The spot to look into for a higher abstracted API to interact with a RemoteConsole. It simplifies the interaction and hides all complexity.

The currently only existing client is the SimpleClient but I can imagine to add game/server specific implementations in the future.

Motivation

Make the best std lib that provides a low-level implementation but also offers packages/ways to abstract the handling with single packets.

License

This lib is licensed under the MIT License and contains parts of the implementation from james4k/rcon.

Contributors

If you should encounter a bug or a missing feature don't hesitate to open an issue or even submit a pull-request.