https://github.com/rcontf/rcon

Complete implementation of the Source RCON Protocol
https://github.com/rcontf/rcon

deno minecraft-rcon rcon rcon-client rcon-protocol rcon-srcds source-rcon source-rcon-protocol srcds-rcon

Last synced: about 1 month ago
JSON representation

Complete implementation of the Source RCON Protocol

• Host: GitHub
• URL: https://github.com/rcontf/rcon
• Owner: rcontf
• License: mit
• Created: 2021-12-15T23:27:43.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T23:00:27.000Z (about 2 months ago)
• Last Synced: 2024-10-30T01:45:57.628Z (about 2 months ago)
• Topics: deno, minecraft-rcon, rcon, rcon-client, rcon-protocol, rcon-srcds, source-rcon, source-rcon-protocol, srcds-rcon
• Language: TypeScript
• Homepage: https://jsr.io/@c43721/rcon
• Size: 38.1 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-tf2-devs - rcontf/rcon - typescript - library for interacting with the rcon protocol (Table of contents / Hosting)

README

        
# Deno Source RCON Protocol

Complete implementation of the

[Source RCON Protocol](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol).

## Install

Checkout the [jsr page](https://jsr.io/@c43721/rcon) for more details.

### Examples

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

```ts

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](https://jsr.io/@c43721/rcon/doc) or see the [cli.ts file](cli.ts).

## 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

- EnriqCG's [rcon-srcds](https://github.com/EnriqCG/rcon-srcds)

- ribizli's [deno_rcon](https://github.com/ribizli/deno_rcon)

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](LICENSE) for more information.