magicoli/opensim-rest-php

OpenSimulator REST PHP library and command-line client

v1.0.5 2023-07-21 02:01 UTC

Requires (Dev)

• clue/phar-composer: ^1.4
• magicoli/php-bump-library: ^1.0

AGPL-3.0-or-later

• Olivier van Helden

README

This library allows to communicate with Robust or OpenSimulator instance with rest console enabled.

It can be used inside a PHP project, or as a command-line client for OpenSimulator grids.

Available commands can be found here: http://opensimulator.org/wiki/Server_Commands

Prerequisites

Remote connection must be enabled in your Robust .ini file.

Do not leave default values!. You should never need to type username and password manually, so you can safely generate long random strings.

You must choose a specific port, not already used by another service. It is good practice to limit access to this port to authorized IP addresses only in your firewall settings.

[Network]
  ConsoleUser = arandomgeneratedstring
  ConsolePass = anotherrandomgeneratedstring
  ConsolePort = 8009
  ; choose a port not already used by another service

Command-line client

Download the executable from this repository, make sure opensim-rest-cli is executable and move it to /usr/local/bin/.

chmod +x /path/to/opensim-rest-cli
sudo mv /path/to/opensim-rest-cli /usr/local/bin/opensim-rest-cli

You can run commands like

opensim-rest-cli /path/to/Robust.ini show info
opensim-rest-cli /path/to/Robust.ini show regions

If you save the credentials in ~/.opensim-rest-cli.ini, you can skip the Robust.ini argument.

opensim-rest-cli show info
opensim-rest-cli show regions

PHP class

Download class-rest.php file in your project or install with composer. Do not keep opensim-rest-cli or opensim-rest-cli.php inside a public website.

composer require --dev https://github.com/magicoli/opensim-rest-php
cp magicoli/opensim-rest-php/class-rest.php lib/

In your project PHP:

require(dirname(__FILE__) . '/lib/class-rest.php');

$session = opensim_rest_session(
  array(
    'uri' => "yourgrid.org:8009",
    'ConsoleUser' => 'yourConsoleUsername',
    'ConsolePass' => 'yourConolePassword',
  )
);

if ( is_opensim_rest_error($session) ) {
  error_log( "OpenSim_Rest error: " . $session->getMessage() );
} else {
  $responseLines = $session->sendCommand($command);
}

# Return value: an array containing the line(s) of response or a PHP Error