dev-lancer/mc-pack

This package is abandoned and no longer maintained. No replacement package was suggested.

The library is designed to integrate the minecraft server with the website.

v2.0.1-stable 2020-11-08 11:56 UTC

Requires

• php: >=7.4
• phpseclib/phpseclib: ^2.0
• thedudeguy/rcon: ^1.0
• xpaw/php-minecraft-query: ^4.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Jakub Gniecki

• php
• library
• console
• query
• server
• ssh
• rcon
• sftp
• properties
• minecraft
• www
• motd

README

Installation

This library can installed by issuing the following command:

composer require dev-lancer/mc-pack

Query

This method uses GameSpy4 protocol, and requires enabling query listener in your server.properties like this:

enable-query=true
query.port=25565

Rcon

This method allows you to send commands, it is used in item shop, and requires enabling rcon listener in your server.properties like this:

enable-rcon=true
rcon.port=25575
rcon.password=pass

Example

Query & Rcon

It enables downloading basic server information and sending commands.

<?php
    require 'vendor/autoload.php';
    
    use DevLancer\MCPack\ConsoleRcon;
    use DevLancer\MCPack\Query;
    use DevLancer\MCPack\ServerManager;

    $info = new Query("some.minecraftserver.com", 25565);
    $console = new ConsoleRcon("some.minecraftserver.com", 25575, "pass", 3);
    $server = new ServerManager($info, $console);

    $players = $server_manager->getInfo()->getCountPlayers();
    echo $players . "/" . $server_manager->getInfo()->getMaxPlayers();

    $server_manager->getConsole()->sendCommand("bc MCPack");

Query & Rcon with SSH

It enables downloading basic server information, sending commands and server management.

<?php
    require 'vendor/autoload.php';
    
    use DevLancer\MCPack\ConsoleRcon;
    use DevLancer\MCPack\Query;
    use DevLancer\MCPack\ServerManagerSsh;
    use DevLancer\MCPack\Ssh;
    use phpseclib\Net\SFTP;

    $host = "some.minecraftserver.com";
    $ssh = new Ssh(new SFTP($host), "username", "password");


    $info = new Query($host, 25565);
    $console = new ConsoleRcon($host, 25575, "pass", 3);
    $server = new ServerManagerSsh($info, $console, $ssh, 25565);

    $path = "path/to/minecraft/server.jar";
    if(!$server_manager->isRunning()) {
        if ($server_manager->run(["-Xmx1G"], $path))
            echo "server started";
    }

Server logs

This class allows downloading logs from the server.

<?php
    require 'vendor/autoload.php';
    
    use DevLancer\MCPack\Logs;
    use DevLancer\MCPack\Ssh;
    use phpseclib\Net\SFTP;

    $host = "some.minecraftserver.com";
    $ssh = new Ssh(new SFTP($host), "username", "password");

    $path = "path/to/minecraft/logs/latest.log";
    $logs = new Logs($ssh->getSftp(), $path);
    echo implode("<br />", $logs->getLogs(true));

Properties

<?php
    require 'vendor/autoload.php';
    
    use DevLancer\MCPack\Properties;
    use DevLancer\MCPack\Ssh;
    use phpseclib\Net\SFTP;

    $host = "some.minecraftserver.com";
    $ssh = new Ssh(new SFTP($host), "username", "password");

    $properties = new Properties($ssh->getSftp(), "path/to/minecraft/server.properties");
    $port = (int) $properties->getProperty("server-port");
    $query_port = (int) $properties->getProperty("query.port");
    $rcon_port = (int) $properties->getProperty("rcon.port");
    $rcon_pass = $properties->getProperty("rcon.password");

Motd

<?php
    require 'vendor/autoload.php';
    
    use DevLancer\MCPack\Motd;use DevLancer\MCPack\Ping;

    $host = "some.minecraftserver.com";
    $info = new Ping($host, 25565);

    $motd = new Motd($info);
    $motd->sendRequest(Motd::REQUEST_EXTRA);
    
    echo $motd->getResponse(Motd::RESPONSE_HTML);

License

MIT