A library for creating Half-Life Dedicated Server (a.k.a “HLDS”) remote connections (a.k.a “rcon”) and executing commands.

Uses a DynamicSupervisor for connecting clients. If you want to manage the rcon client supervision yourself you can use the HLDSRcon.RconClient module directly.

Examples

If you are running a server on the localhost with the HLDS rcon_password set to Foo, you would connect;

  {:ok, _pid} = HLDSRcon.connect("127.0.0.1", "Foo")

Now that the connection is established, you can run commands;

  {:ok, _response} = HLDSRcon.command("127.0.0.1", "echo Test")

Some common command responses are processed into structs for ease of use;

  {:ok, %HLDSRcon.Stats{} = stats} = HLDSRcon.command("127.0.0.1", "stats")

These common commands also have entry points in this module, e.g. instead of calling command to run stats as above, we could simply call;

  {
    :ok,
    %HLDSRcon.Stats{
     cpu: 11.33,
     fps: 921.12,
     in: 0.0,
     out: 0.0,
     players: 0,
     uptime: 895,
     users: 0
    }
  } = HLDSRcon.stats("127.0.0.1")