Git Product home page Git Product logo

retrorcon-php's Introduction

Latest Stable Version License

retrorcon-php

This PHP library is used to get information such as users online, refreshing users' look and doing housekeeping activity such as e.g. sending room alerts by communicating with emulators adhering to the RetroRCON standard.

The project requires PHP 7.2 or higher and uses composer's autoloader following the PSR-4 standard.

How to use it

  1. Install and configure the PHP gRPC extension
  2. Install and configure the PHP Protobuf extension
  3. Install and learn how to use composer
  4. Add the composer package to your project by running composer require ewout/retrorcon
  5. Make sure to include composer's autoloader
  6. Look at the snippet below on how to use the library

Usage

<?php
// Include the Composer autoloader
include 'vendor/autoload.php';

// Shortcut for the FQN
use RetroRCON\RemoteConnection;

// Create new RCON instance
$rcon = new RemoteConnection(
    [
        'host' => '127.0.0.1',
        'port' => 12309
    ]
);

// Get online user count
$onlineCount = $rcon->getOnlineCount();

// Is user 'Ewout' online?
$isOnline = $rcon->isUserOnline("Ewout");

// Supports user ID too
$userId = 1;
$isOnline = $rcon->isUserOnline($userId);

// Refresh user figure if online (only meant to be used when figure/motto changed)
if ($isOnline) {
    $rcon->refreshLook($userId);
}

retrorcon-php's People

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.