README

Collection of PHP scripts to complement OpenSimulator features.

Description

Collection of PHP scripts to enable OpenSimulator features that are not implemented in the core, like search, currency, events in OpenSimulator grids (see Features below).

Most files are used directly by viewer to allow features not implemented in OpenSimulator, like classifieds, events, etc.

They were initially based on a collection of different projects (see Credits below), but were entirely rewritten to use an unified code and set of parameters, as well as for integration in larger projects like w4os OpenSim WordPress Interface.

Formerly known as Flexible Helper Scripts.

Project URL: https://github.com/magicoli/opensim-helpers
Donate: https://w4os.org/donate/

Features

In-world Search: enable standard search in the viewer for places, land for sale, events and classifieds.
Events: sync events from HYPEvents server
Currency: provide helpers for currency (MoneyServer, Gloebit and Podex)
Offline messaging: add mail forwarding option to offline IM (according to user viewer settings)
Multi-grid: can be used for standalone or closed grid as well as to provide a cross-grid search engine
Unified library: rewritten to allow easier integration in bigger projects

Roadmap

Avatar authentication
Avatar registration
Web profiles
Web assets server
Web search
Grid info
Grid status
Splash page

Installation

For detailed installation instructions, please see INSTALLATION.md.

If you encounter issues during installation or usage, please refer to TROUBLESHOOTING.md.

Quick Start Options

Option 1: Just enable in-world search (no helpers installation)

If you only need basic in-world search, you can use an external service like 2do directory without installing the helpers.

Download OpenSimSearch.Module.dll and put it inside your OpenSim bin/ folder.
Add search settings to OpenSim.ini:

[Search]
SearchURL = "https://2do.directory/helpers/query.php?gk=${Const|BaseURL}:${Const|PublicPort}"

[DataSnapshot]
index_sims = true
gridname = "Your Grid"
snapshot_cache_directory = "./DataSnapshot"
DATA_SRV_2do = http://2do.directory/helpers/register.php

Restart the simulators.

Option 2: WordPress website

If you have a WordPress website, we recommend installing W4OS Plugin which includes these helpers along with many other features like avatar registration and web profiles.

Option 3: Full helpers installation

For a complete installation with all features (search, currency, events, etc.), see the detailed instructions in INSTALLATION.md.

Credits

Version 2.x is This is a complete rewrite. The initial project was basicly a meta installer, combining several other projects repositories. It has been completely rewritten to ease installation, as well as ease inclusion in other projects like W4OS OpenSim Web Interface.

While most of the code is new or rewritten from scratch, portions of code may remain from the original projects, including:

Unless otherwise specified, code is distributed as part of Flexible Helper Scripts package, under Affero GPL v3 license.

magicoli / opensim-helpers

Maintainers

Details