https://github.com/thebozzz34/minecraft-rcon
YAMRC establishes a connection to an RCON server, authenticates using a password, and sends commands to the server.
https://github.com/thebozzz34/minecraft-rcon
minecraft nodejs rcon rcon-client rcon-protocol typescript
Last synced: about 1 year ago
JSON representation
YAMRC establishes a connection to an RCON server, authenticates using a password, and sends commands to the server.
- Host: GitHub
- URL: https://github.com/thebozzz34/minecraft-rcon
- Owner: TheBozzz34
- License: agpl-3.0
- Created: 2023-12-21T21:48:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-21T22:50:58.000Z (over 2 years ago)
- Last Synced: 2025-03-04T08:18:38.608Z (about 1 year ago)
- Topics: minecraft, nodejs, rcon, rcon-client, rcon-protocol, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/yamrc
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yet another RCON (Remote Console) Connection Library
The RCON protocol facilitates remote interaction with a server via its console interface. This Node.js library establishes a connection to an RCON server, authenticates using a password, and sends commands to the server.
## Installation
To install the RCON library, follow these steps:
Install from NpmJS:
```bash
npm install yamrc
```
Usage Example
```javascript
const Rcon = require('yamrc').Rcon;
// Initialize RCON connection
const rconClient = new Rcon('server_address', rcon_port, 'rcon_password');
// Connect to the server and run the "list" command
async function main() {
await rconClient.connect()
console.log(await rconClient.send('list'))
await rconClient.disconnect()
}
main()
```
## API Reference
`Rcon(host: string, port: number, password: string)`
Parameters:
- host: The host address of the RCON server.
- port: The port number for the RCON connection.
- password: The password required for RCON authentication.
Methods
```
connect(): Promise
Establishes a connection to the RCON server.
disconnect(): Promise
Closes the connection to the RCON server.
send(command: string): Promise
Sends a command to the RCON server.
command: The command string to be sent.
isAuthenticated()
Returns the auth status of the rcon connection
isConnected()
Returns whether the socket is connected or not
```
Notes
- Ensure the server address, port, and RCON password are correctly provided.
- This library uses promises for asynchronous operations.
- Commands can be sent only after successful authentication.