OpenSim Helpers, de bibliotheek die de kern vormt van de w4os plugin, heeft eindelijk goede installatie-instructies – en een eigen website: https://opensimulator-helpers.dev/. Dit had al veel eerder moeten gebeuren.

Na feedback van gebruikers hebben we hard gewerkt om de installatie van standalone helpers eenvoudiger te maken. Zoals gewoonlijk is het werk in uitvoering, maar het is al een enorme verbetering.

OpenSim Helpers (voorheen Flexible Helpers Scripts) is een verzameling van webscripts en bibliotheken die gebruikt worden naast een OpenSimulator installatie. Ze worden gebruikt door grids of standalone simulators om functionaliteiten te bieden die niet in de OpenSim kern zitten en die een web-side implementatie vereisen – zoals zoeken, financiële transacties en offline berichten doorsturen.

Helpers worden gebundeld met de w4os plugin, maar zijn ook beschikbaar als een standalone bibliotheek, waardoor integratie in elke website mogelijk is, ongeacht of deze een CMS gebruikt. In dergelijke gevallen worden ze meestal geïnstalleerd in een submap, zoals example.org/helpers.

Optioneel kunnen helpers ook onafhankelijk geïnstalleerd worden, naast een webinterface zoals w4os, om de prestaties te verbeteren.

Huidige functies

  • Zoeken in de wereld – Zoek plaatsen, te koop staande grond, advertenties en evenementen vanuit het klassieke zoekpaneel van de kijker.
  • Valuta – Maak transacties mogelijk zoals het verkopen van land of objecten, het betalen van avatars. Kan worden geconfigureerd met diensten van derden zoals Gloebit of Podex, of zelfs lokaal. (Zelfs nepvaluta is nodig voor functies zoals gratis land verkopen of groepen maken).
  • Landtool – transacties per perceel mogelijk maken (gratis of betaald)
  • Offline berichten doorsturen – Offline IM’s doorsturen naar e-mailadressen van avatars (vereist inschakelen in viewerinstellingen)
  • Bestemmingsgids – Ondersteuning voor v3 viewer bestemmingsgids

Installatie-instructies

OpenSim Helpers bestaan uit scripts, sommige nieuw geschreven en sommige afkomstig van verschillende oudere projecten. Ze zijn samengevoegd om de configuratie te vereenvoudigen. OpenSimulator kan echter nog steeds lastig zijn – vooral zonder documentatie.

Die leemte is nu opgevuld: de installatiestappen zijn gedocumenteerd in het bestand INSTALLATION.md. Dit zou een nuttige leidraad moeten zijn voor nieuwe gebruikers van de bibliotheek.

Nieuwe website

Open source projecten worden meestal gehost op platformen zoals GitHub – en dat geldt ook voor opensim-helpers(https://github.com/magicoli/opensim-helpers). Maar niet alle potentiële gebruikers zijn bekend met deze platforms. Daarom hebben we een eenvoudige, speciale website voor het project gemaakt, gericht op de essentie

Het is niet luxe. Het doel is om het schoon en eenvoudig te houden – zonder de toeters en bellen van GitHub – en het gedoe van handmatig onderhoud te vermijden.

Kanttekening: de tool voor het maken van websites

Omdat alle belangrijke informatie al bestaat in de GitHub repository (als Markdown-bestanden), hebben we een speciale tool ontwikkeld om de website rechtstreeks vanuit de repo te synchroniseren. Op deze manier blijft de site automatisch up-to-date met de documentatie die ontwikkelaars maken.

  • Genereert een statische website voor prestaties en minimale belasting van de server (pagina’s worden regelmatig bijgewerkt via cron)
  • Gebruikt Bootstrap voor een schone, responsieve, lichtgewicht lay-out
  • Maakt basispagina’s van .md bestanden (bijv. README.md als startpagina, andere zoals INSTALLATION.md, TROUBLESHOOTING.md, CHANGELOG.md toegevoegd aan het menu)
  • Biedt een downloadpagina (laatste stabiele release en dev installatie-instructies)
  • Bevat een ondersteuningspagina (die het gebruik van GitHub issues aanmoedigt)
  • Biedt een donatiepagina (gekoppeld aan GitHub Sponsors)

De generator zelf is ook open source en hier beschikbaar: https://github.com/magicoli/php-site-generator.
(Het heeft geen eigen website – dus meta 😅)

Alternatieven

Zoals eerder vermeld, kan OpenSimulator Helpers worden geïnstalleerd als een standalone oplossing, geïntegreerd met een webinterface of gebruikt in combinatie met een webinterface.

De eenvoudigste optie is vaak om een volledige webinterface te installeren, die meestal de helpers bevat samen met hulpmiddelen voor gebruikersregistratie, accountbeheer, enz. Er bestaan verschillende interessante projecten – met of zonder CMS – met name w4os (natuurlijk), OSMW en Diva:
http://opensimulator.org/wiki/Webinterface

Dat gezegd hebbende, in sommige gevallen is het zinvoller om de helpers onafhankelijk uit te voeren, ofwel om prestatieredenen of wanneer er geen interface nodig is. Veel van de functies die nu in OpenSim Helpers zitten waren ooit beschikbaar in aparte, vaak verlaten, projecten. We zullen ze niet allemaal opnoemen, maar we zijn de oorspronkelijke ontwikkelaars dankbaar voor hun werk dat de basis legde voor deze bibliotheek.


Vooruitblik

We zullen zowel w4os als opensim-helpers parallel blijven ontwikkelen, zodat zowel de volledige webinterface als de standalone backend up-to-date blijven. Sommige functies die zijn geïntroduceerd in w4os en het 2do Directory project zullen worden gemigreerd naar de helpers wanneer dat nodig is. We zijn ook van plan om de code te reorganiseren om de integratie tussen verschillende projecten te vergemakkelijken.

Over Speculoos Wereld

Speculaaswereld is een 3D virtuele wereld opgericht in 2011, gebaseerd op OpenSimulator. Het onderhoudt zowel w4os en opensim-helperssamen met verschillende andere OpenSim-gerelateerde projecten. Oorspronkelijk gebouwd om te voldoen aan de behoeften van de Speculoos grid, zijn ze open-sourced om te delen met de bredere OpenSimulator gemeenschap.

(Oorspronkelijke post op W4OS – Lees meer)

+