dev-lancer / minecraft-rcon

v1.0 2024-07-28 18:22 UTC

Requires

• php: >=7.4

MIT

• Chris Churchwell
• Jakub Gniecki

• php
• server
• rcon
• minecraft

Published on Packagist.org on 2024-07-26 18:33 UTC

README

PHP library to request RCON for Minecraft servers

Installation

Using Composer

This Rcon library may be installed by issuing the following command:

$ composer require dev-lancer/minecraft-rcon

Example

For this script to work, rcon must be enabled on the server, by setting enable-rcon=true in the server's server.properties file. A password must also be set, and provided in the script.

$host = 'some.minecraftserver.com'; // Server host name or IP
$port = 25575;                      // Port rcon is listening on
$password = 'server-rcon-password'; // rcon.password setting set in server.properties
$timeout = 3;                       // How long to timeout.

use DevLancer\MinecraftRcon;

$rcon = new Rcon($host, $port, $password, $timeout);

if ($rcon->connect()) {
    if ($rcon->sendCommand("say Hello World!") === false) {
        //bad request
    } else {
        echo $rcon->getResponse(); //success
    }
} else {
    echo $rcon->getResponse(); //error
}