OpenSimulator · FR

Display Names : installation, fonctionnement et dépannage

Guide complet du module Display Names compatible Firestorm, pour OpenSimulator 0.9.3.x.

Module tiers communautaire : vérifier la version et les règles de sécurité avant toute exposition publique. Ce guide accompagne le dépôt source, sans remplacer ses instructions et mises à jour.

Télécharger le module Display Names

Archive ZIP officielle précompilée pour OpenSimulator 0.9.3.1, release v1.0.0. Pour toute autre révision, compiler le module à partir des sources correspondant au serveur.

Télécharger le ZIP — OpenSimulator 0.9.3.1

Voir la release officielle · Voir les fichiers précompilés · Code source du module

Le service PHP/MySQL est distinct : télécharger aussi le dépôt source pour web/displayname/ et database/displaynames.sql, puis suivre le guide complet.

Fonctionnement et compatibilité

Display Names est un module communautaire non officiel apportant les noms d’affichage compatibles Firestorm à OpenSimulator 0.9.3.x. Le dépôt propose une DLL précompilée testée pour 0.9.3.1. Pour une autre révision, recompiler contre les sources exactes du serveur. Le nom d’affichage ne remplace pas le username utilisé pour se connecter.

Architecture : backend commun et modules par simulateur

Le système utilise un backend PHP/MySQL HTTPS partagé par la grille et un module installé dans chaque simulateur qui doit exposer les CAPS Display Names. Les changements peuvent être communiqués aux viewers voisins. Les UUID Hypergrid non reconnus localement doivent être traités comme inconnus et laisser le viewer utiliser les noms legacy, pas être convertis artificiellement en comptes locaux.

Prérequis et fichiers fournis

Prévoir HTTPS, PHP et PDO MySQL, une base MySQL et la table UserAccounts de ROBUST accessible en lecture par le backend. La version précompilée pour OpenSimulator 0.9.3.1 fournit DLL, PDB et manifeste Mono.Addins. Sauvegarder les versions précédentes et arrêter le simulateur avant de remplacer les binaires.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

precompiled/OpenSimulator-0.9.3.1/DisplayNameSimModule.dll
precompiled/OpenSimulator-0.9.3.1/DisplayNameSimModule.pdb
precompiled/OpenSimulator-0.9.3.1/DisplayNameSimModule.addin.xml
# À copier dans bin/ du simulateur concerné

Créer la base de données Display Names

Créer une base dédiée avec un nom adapté, puis importer database/displaynames.sql du dépôt du module dans cette base. Le schéma crée display_names (nom et prochaine modification possible) et display_name_history (historique set/reset). Ne pas confondre cette base avec ROBUST.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

CREATE DATABASE opensim_displaynames CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;
-- Ensuite importer database/displaynames.sql dans cette base.

Privilèges SQL à accorder

Le guide d'installation indique : SELECT sur robust.UserAccounts pour lire les noms legacy, et SELECT/INSERT/UPDATE/DELETE sur la base Display Names. Adapter les noms, l'hôte MySQL autorisé et le secret. Éviter root et ne pas exposer MySQL à Internet.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

CREATE USER 'displaynames_user'@'localhost' IDENTIFIED BY 'SECRET_A_CHANGER';
GRANT SELECT ON `robust`.`UserAccounts` TO 'displaynames_user'@'localhost';
GRANT SELECT, INSERT, UPDATE, DELETE ON `opensim_displaynames`.* TO 'displaynames_user'@'localhost';

Installer et paramétrer le service PHP

Copier web/displayname/ du dépôt vers le serveur web HTTPS. Dupliquer config/config.php.example en config/config.php puis adapter db_host, db_port, db_user, db_pass, db_displaynames et db_robust. Ne jamais publier config.php dans Git et protéger les répertoires config et logs contre les accès HTTP. Le chemin de ServiceBase sera celui du service, sans /get.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

'db_host' => '127.0.0.1',
'db_port' => 3306,
'db_user' => 'displaynames_user',
'db_pass' => 'SECRET_A_CHANGER',
'db_displaynames' => 'opensim_displaynames',
'db_robust' => 'robust',
'change_delay_days' => 7,

Attention à la sécurité de /set et /reset

Le dépôt fournit allow_all_ips=true pour accepter les requêtes de simulateurs distants. Dans le backend actuel, ce réglage autorise les écritures depuis les IP non filtrées : il ne constitue PAS une authentification. En production publique, un utilisateur malveillant pourrait tenter de modifier des noms via les endpoints. Protéger les écritures avec une authentification backend solide et/ou un filtrage réseau adapté, à valider avant l'ouverture ; changer simplement cette option en false peut empêcher toutes les modifications, pas créer une liste blanche.

Tester les endpoints avant d'installer le module

Tester GET /get avec un UUID local sur l'URL HTTPS finale, qui doit renvoyer du JSON. Les routes attendues sont GET /get, POST /set et POST /reset. Si 404, vérifier .htaccess, mod_rewrite/AllowOverride et l'emplacement du dossier. Éviter les redirections HTTP 301/302 pour les POST.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

curl -i 'https://grid.example/displayname/get?id=UUID_LOCAL'

Déclarer [DisplayNameCaps] dans OpenSim.ini

Ajouter ce bloc comme section autonome dans le fichier OpenSim.ini réellement chargé. ServiceBase ne doit contenir ni /get, ni /set, ni /reset, ni /index.php. Les autres paramètres contrôlent timeout HTTP, TTL du cache, nombre de requêtes simultanées et journalisation détaillée.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

[DisplayNameCaps]
ServiceBase = "https://grid.example/displayname"
HttpTimeoutMs = 5000
CacheTtlMinutes = 30
MaxConcurrentServiceCalls = 5
Verbose = true

Activer le module dans [Modules]

Dans le GridCommon.ini chargé par ce simulateur, identifier la section [Modules] existante et ajouter DisplayNameCapsModule à SharedRegionModules. Ne pas supprimer les modules partagés déjà déclarés, et ne pas créer une deuxième clé SharedRegionModules. Le fichier réel peut être différent suivant l'architecture.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

[Modules]
SharedRegionModules = "DisplayNameCapsModule"
# Exemple si aucune autre valeur n’existe déjà.

Compiler pour une autre version OpenSimulator

Pour une version 0.9.3.x non identique à la DLL fournie, placer source/DisplayNameSimModule dans addon-modules/DisplayNameSimModule de l'arbre source OpenSimulator correspondant, exécuter runprebuild, puis compiler la solution Release. Vérifier au final les DLL et le manifeste générés. Le module est destiné à OpenSimulator, pas à être installé dans le processus ROBUST.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

# Linux (à la racine du code source OpenSimulator) :
./runprebuild.sh
dotnet build OpenSim.sln --configuration Release
# Windows : runprebuild.bat puis dotnet build OpenSim.sln --configuration Release

Vérifier le chargement et la première connexion Firestorm

Après redémarrage, rechercher Plugin Loaded: DisplayNameSimModule et [DisplayNameCaps]: MODULE LOADED dans OpenSim.log ; un module partagé doit être chargé une fois, pas deux fois. Si Mono.Addins ne découvre pas le module, arrêter le simulateur, sauvegarder puis renommer addin-db-004 uniquement si présent. Un premier vidage du cache Firestorm et redémarrage du viewer peut être nécessaire après activation initiale.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

grep -nEi 'DisplayNameCaps|DisplayNameSimModule|ERROR|exception' /chemin/vers/OpenSim.log | tail -n 100

Tester le fonctionnement de bout en bout

Tester : affichage du nom au-dessus de l'avatar et dans le profil, accès au username legacy, changement, reset, mise à jour sur un deuxième viewer, puis comportement des contacts Hypergrid. Répéter sur chaque simulateur activé ; ne pas supposer qu'un module installé sur une région fonctionne partout.

Dépannage par les logs

Si les contrôles Firestorm sont grisés : confirmer CAPS dans OpenSim.log avant de vider le cache viewer. Si 404 : vérifier la réécriture Apache et ServiceBase. Si le backend enregistre le nom mais le viewer affiche une erreur : vérifier statut HTTP et réponse CAPS. Si reset ne rafraîchit pas les voisins : vérifier DisplayNameUpdate et EventQueue. Pour des UUID Hypergrid non reconnus, rechercher les erreurs réelles sans conclure que tout 404 est une panne.

Exemple à adapter : ne jamais copier les identifiants et chemins sans vérification.

# Simulateur :
grep -nEi 'DisplayNameCaps|DisplayNameSimModule|exception|ERROR' /chemin/vers/OpenSim.log | tail -n 120
# Web PHP/Apache : consulter le journal d’erreurs réel du vhost
# Backend, seulement si debug=true et droits de fichiers adaptés :
tail -n 100 /chemin/vers/displayname/logs/displaynames.log

Sauvegardes, historique et exploitation

Sauvegarder display_names et display_name_history avec la base des comptes ROBUST et la configuration du backend. Les changements appliqués par change_delay_days sont stockés côté backend ; 0 signifie aucun délai, 7 signifie sept jours. Les logs de debug peuvent contenir des données personnelles et des IP ; limiter l'accès, la durée de conservation et désactiver le debug inutile en production.

Guides officiels du module et fichiers sources

Méthodologie générale pour lire les logs