Project Category: OpenSimulator Helpers

  • OpenSimulator Helpers

    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.

  • w4os – OpenSimulator Web Interface (dev)

    Ready to use WordPress interface for OpenSimulator. Provides user registration, default avatar model choice, login info, statistics and a web assets server for grids or standalone simulators.

    Full installation instructions

    Theme compatibility list

    See Features and Roadmap sections for current and upcoming functionalties.

  • OpenSimMaps (standalone)

    The web map tool for OpenSimulator, for

    • standalone use
    • or integration with

    Support this project: https://magiiic.com/support/OpenSimMaps

    Features

    • show grid map with region maptiles
    • click to get a choice of teleport methods
    • supports varregions
    • supports multiple maps
    • uses Google Maps v3 API

    New

    • allow standalone use: include minimal settings, independant to other helpers or web interface
    • include settings for integration with Flexible Helper Scripts
    • separate settings file from the rest of the code: one for php (config.php), one for javascript (config.js)
    • distribution now contains only example settings file, to alow smooth update without losing config
    • added hop:// to teleport link choices

    TODO

    • remove old API key probably belonging to one of the original developers
    • … and many other things whose details would be laborious (so much to do, so little time)
    • please use issues to request new features or report bugs

    Installation

    • clone this folder inside your website documentroot, e.g /var/html/opensimmaps/, to make it accessible as https://yourgrid.org/opensimmaps/ (you can rename it)
    • Copy config.php.example as config.php and adjust settings (this helper only needs database credentials OPENSIMDB*)
    • Copy config.js.example as config.js and adjust settings (particularly xlocations, ylocations, mapcenternames, hgdomains and hgports)
    • make a soft link from the OpenSim maptile/00000000-0000-0000-0000-000000000000 folder to data/regions/, for example on linux (adjust to your setup):
      ln -s /opt/opensim-0.9.2.0/bin/maptiles/00000000-0000-0000-0000-000000000000 /var/html/opensimmaps/data/regions

    Alternatively, you can make data/regions/ folder and copy the maptiles in it, but it won’t be updated automatically.

    • Original readme specified to rather use Warp3DImageModule, but it is now the default. Your OpenSim.ini file should contain these settings:
      [Map]
        MapImageModule = "Warp3DImageModule"
        TextureOnMapTile = true
        DrawPrimOnMapTile = true

    Credits

    Based on hawddamor’s opensimmaps (optimized for OpenSim Redux web interface).

    This is a modified version of hawddamor/opensimmaps. The modifications from the original project are mainly related to file locations and some variable names.

    More information on original project and authors in README and LICENSE files.

  • Offline-Messages-mail-forwarding

    Offline messages (IM) mail forwarding for OpenSimulator https://github.com/GuduleLapointe/offline-mail-forwarding

    GNU AFFERO GENERAL PUBLIC LICENSE (see LICENSE file)

    Warning

    This forwarder might look easy to setup, but it is not an easy job. Mail forwarding will expose your server. So you ABSOLUTELY need to have a secured server to avoid being hacked or used by spammers.

    Among other things:

    • use SSL, disallow unencrypted access to this script
    • if you have a mail relay installed on your server, deny relay from non authenticated users;
    • avoid allowing group messages relaying if possible;
    • keep watching your OpenSimulator, mail and web server logs to detect any abuse.

    Features

    • Forward instant messages by mail when the user is offline
    • Replacement for the usual offline message script, so it also handles local delivery

    Caveats

    It is an external script. It is called where the sender stands by the region simulator, because that’s where you can call an external offline message script.

    This means:

    • if somebody sends a message from another grid, it will not be forwarded because the other grid has no access to HG users email and IM preferences
    • if it is sent from a region where the script it is not installed, the message will not be forwarded either

    This can be good, as it limits possible abuses, but a better approach would be to intercept the message on the grid level (in Robust instance), and from there allow or disallow forwarding from HG senders, but this would need changes in OpenSimulator core software.

    So this project is, and will stay, a workaround, not perfect but useful until we or somebody else develop the core module.

    Installation

    On your webserver

    You webserver needs access to the OpenSimulator database.

    • copy the content in a folder called "offline" (or whatever you like) in your webroot directory.
      git clone https://github.com/GuduleLapointe/offline-mail-forwarding.git offline
    • inside this directory, compy the example config file and adjust to your settings
      cp config.php.example config.php

    In OpenSimulator (grid or standalone)

    • In OpenSim.ini file adjust or add these setting under section [Messaging]. On a grid, this has to be set for every region.
      [Messaging]
      OfflineMessageModule = OfflineMessageModule
      ; OfflineMessageModule = "Offline Message Module V2"
      OfflineMessageURL = http://your.server/offline/offline.php
      StorageProvider = OpenSim.Data.MySQL.dll
      MuteListModule = MuteListModule
      MuteListURL = ${Const|BackOffice}/mute.php
      ForwardOfflineGroupMessages = false

      In the viewer

    Now mail forwarding is active on the server, but users wanting to enable it have to do it from viewer preferences (in Chat or Communication tab).