# rustrcon

> RCON wrapper for rust.

Latest version **1.0.2** (published 2019-03-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install rustrcon
pnpm add rustrcon
yarn add rustrcon
bun add rustrcon
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-03-06 |
| First published | 2019-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Artful |
| Maintainers | artful-dev |

## Links

- npm: https://www.npmjs.com/package/rustrcon
- npm.io page: https://npm.io/package/rustrcon

## Dependencies (1)

- [ws](https://npm.io/package/ws.md) ^6.1.2

## Recent versions

- 1.0.2 (latest) — 2019-03-06
- 1.0.1 — 2019-01-09
- 1.0.0 — 2019-01-09

## README

# RustRCON
Rust RCON client for NodeJS

`npm install rustrcon`
or
`yarn add rustrcon`

Usage
-----
```js
const { Client } = require('../src/index.js');

const rcon = new Client({
	ip: '192.0.0.1',
	port: '8080',
	password: '123'
});

rcon.login();

rcon.on('connected', () => {
	console.log(`Connected to ${rcon.ws.ip}:${rcon.ws.port}`);

	// Message, Name, Identifier.
	rcon.send('serverinfo', 'Artful', 10);

	setTimeout(() => {
		rcon.destroy();
	}, 5000);
});

rcon.on('error', err => {
	console.error(err);
});

rcon.on('disconnect', () => {
	console.log('Disconnected from RCON websocket');
});

rcon.on('message', message => {
	console.log(message);
});

```

## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Credits
Kye [github](https://github.com/KyeNormanGill)
## License
MIT

---
_Source: https://npm.io/package/rustrcon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
