Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.21 KB

README.md

File metadata and controls

42 lines (24 loc) · 1.21 KB

Deno Source RCON Protocol

Complete implementation of the Source RCON Protocol.

Install

Checkout the jsr page for more details.

Examples

A simple example that connects to a server and executes the status command and logs to console

using rcon = new Rcon({ host: "game.example.com", port: 27015 });

const didAuthenticate = await rcon.authenticate("myrconpassword");

console.log(didAuthenticate ? "Authenticated to the server" : "Could not authenticate");

const result = await rcon.execute("status");

console.log(result);

For more examples, see the documentation on jsr or see the cli.ts file.

Contributing

If there's a feature or bug, please raise a github issue first alongside your PR (if you're kind enough to make a PR.)

Acknowledgements

Both of these repositories I've contributed to in the past and am super thankful for their work.

License

Distributed under the MIT License. See LICENSE for more information.