BLOODMOON GRID — DISPLAY NAMES MODULE
Installation Guide / Guide d'installation
OpenSimulator 0.9.3.1
Version: 2026-09-17

======================================================================
🇬🇧 ENGLISH
======================================================================

🎯 PURPOSE

This module enables BloodMoon Display Names on an OpenSimulator instance
connected to the BloodMoon Grid.

This document only explains how to INSTALL the module.


----------------------------------------------------------------------
📦 STEP 1 — FILES TO INSTALL
----------------------------------------------------------------------

You must have these 3 files:

    DisplayNameSimModule.addin.xml
    DisplayNameSimModule.dll
    DisplayNameSimModule.pdb

⚠️ IMPORTANT

Use the BloodMoon-provided version of DisplayNameSimModule.dll.

Do NOT replace it with the original OSgrid DLL.


----------------------------------------------------------------------
🛑 STEP 2 — STOP THE SIMULATOR
----------------------------------------------------------------------

Stop the OpenSimulator instance before replacing or installing the module.

Do not replace the DLL while OpenSimulator is running.


----------------------------------------------------------------------
💾 STEP 3 — BACK UP AN EXISTING INSTALLATION
----------------------------------------------------------------------

If DisplayNameSimModule.dll is already installed, make a backup first.

From the simulator "bin" directory:

    cd /path/to/OpenSim/bin

    cp -a DisplayNameSimModule.dll \
    "DisplayNameSimModule.dll.$(date +%Y%m%d_%H%M%S).bak"

If the folder "addin-db-004" exists, back it up too:

    mv addin-db-004 \
    "addin-db-004.$(date +%Y%m%d_%H%M%S).bak"

OpenSimulator will automatically recreate "addin-db-004" at startup.


----------------------------------------------------------------------
📂 STEP 4 — COPY THE MODULE FILES
----------------------------------------------------------------------

Copy the 3 files into the simulator "bin" directory:

    DisplayNameSimModule.addin.xml
    DisplayNameSimModule.dll
    DisplayNameSimModule.pdb

Example:

    /home/user/OpenSim/MySimulator/bin/DisplayNameSimModule.addin.xml
    /home/user/OpenSim/MySimulator/bin/DisplayNameSimModule.dll
    /home/user/OpenSim/MySimulator/bin/DisplayNameSimModule.pdb


----------------------------------------------------------------------
⚙️ STEP 5 — OPENSIM.INI
----------------------------------------------------------------------

Open:

    bin/OpenSim.ini

Add the following section:

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

⚠️ Do not modify these values unless the BloodMoon administrator asks you
to do so.


----------------------------------------------------------------------
🧩 STEP 6 — GRIDCOMMON.INI
----------------------------------------------------------------------

Open:

    bin/config-include/GridCommon.ini

Locate the existing:

    [Modules]

section.

Make sure DisplayNameCapsModule is enabled as a shared region module.

For a simulator where it is the only explicitly configured shared module:

    [Modules]
    SharedRegionModules = "DisplayNameCapsModule"

⚠️ IMPORTANT

If your simulator already has other custom shared modules in this setting,
do NOT remove them.

Add DisplayNameCapsModule while preserving the existing configuration.

Do not create a second duplicate [Modules] section.


----------------------------------------------------------------------
🔄 STEP 7 — REBUILD THE ADD-IN DATABASE
----------------------------------------------------------------------

After installing or replacing DisplayNameSimModule.dll, remove the current
add-in cache by renaming it.

From the simulator "bin" directory:

    mv addin-db-004 \
    "addin-db-004.$(date +%Y%m%d_%H%M%S).bak"

If "addin-db-004" does not exist, simply continue.

It will be recreated automatically at the next OpenSimulator startup.


----------------------------------------------------------------------
▶️ STEP 8 — START THE SIMULATOR
----------------------------------------------------------------------

Start the OpenSimulator instance normally.

Installation is complete.

The simulator will now use the BloodMoon Display Names service.



----------------------------------------------------------------------
🔥 STEP 9 — FIRESTORM CACHE (VERY IMPORTANT)
----------------------------------------------------------------------

After the Display Name module has been enabled on the simulator, users who
connected to BloodMoon before the upgrade should clear the Firestorm cache
once before using Display Names.

Without clearing the viewer cache, Firestorm may continue to use old cached
capabilities and the option to change the Display Name can remain greyed out.

Recommended procedure:

    1. Log out from BloodMoon.
    2. Clear the Firestorm cache.
    3. Completely close Firestorm.
    4. Restart Firestorm.
    5. Log back in to BloodMoon.

This is normally required only once after the Display Names module has been
activated.


----------------------------------------------------------------------
📌 IMPORTANT
----------------------------------------------------------------------

• Always use the BloodMoon-provided DLL.
• Always stop OpenSimulator before replacing the DLL.
• Keep a timestamped backup of the previous DLL.
• Rebuild "addin-db-004" after replacing the DLL.
• Do not change the DisplayNameCaps values without instructions.
• Do not remove existing modules from GridCommon.ini.
• No local database installation is required.
• The Display Names database and web service are managed by BloodMoon.
• Existing Firestorm users should clear the viewer cache once after activation.


======================================================================
🇫🇷 FRANÇAIS
======================================================================

🎯 OBJECTIF

Ce module active les Display Names BloodMoon sur une instance OpenSimulator
raccordée à la grille BloodMoon.

Ce document explique uniquement l'INSTALLATION du module.


----------------------------------------------------------------------
📦 ÉTAPE 1 — FICHIERS À INSTALLER
----------------------------------------------------------------------

Vous devez disposer de ces 3 fichiers :

    DisplayNameSimModule.addin.xml
    DisplayNameSimModule.dll
    DisplayNameSimModule.pdb

⚠️ IMPORTANT

Utilisez impérativement la version de DisplayNameSimModule.dll fournie par
BloodMoon.

Ne la remplacez PAS par la DLL OSgrid d'origine.


----------------------------------------------------------------------
🛑 ÉTAPE 2 — ARRÊTER LE SIMULATEUR
----------------------------------------------------------------------

Arrêtez l'instance OpenSimulator avant d'installer ou de remplacer le module.

Ne remplacez pas la DLL pendant qu'OpenSimulator est en fonctionnement.


----------------------------------------------------------------------
💾 ÉTAPE 3 — SAUVEGARDER UNE INSTALLATION EXISTANTE
----------------------------------------------------------------------

Si DisplayNameSimModule.dll est déjà installée, faites d'abord une sauvegarde.

Depuis le dossier "bin" du simulateur :

    cd /chemin/vers/OpenSim/bin

    cp -a DisplayNameSimModule.dll \
    "DisplayNameSimModule.dll.$(date +%Y%m%d_%H%M%S).bak"

Si le dossier "addin-db-004" existe, sauvegardez-le également :

    mv addin-db-004 \
    "addin-db-004.$(date +%Y%m%d_%H%M%S).bak"

OpenSimulator recréera automatiquement "addin-db-004" au démarrage.


----------------------------------------------------------------------
📂 ÉTAPE 4 — COPIER LES FICHIERS DU MODULE
----------------------------------------------------------------------

Copiez les 3 fichiers dans le dossier "bin" du simulateur :

    DisplayNameSimModule.addin.xml
    DisplayNameSimModule.dll
    DisplayNameSimModule.pdb

Exemple :

    /home/user/OpenSim/MonSimulateur/bin/DisplayNameSimModule.addin.xml
    /home/user/OpenSim/MonSimulateur/bin/DisplayNameSimModule.dll
    /home/user/OpenSim/MonSimulateur/bin/DisplayNameSimModule.pdb


----------------------------------------------------------------------
⚙️ ÉTAPE 5 — OPENSIM.INI
----------------------------------------------------------------------

Ouvrez :

    bin/OpenSim.ini

Ajoutez la section suivante :

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

⚠️ Ne modifiez pas ces valeurs sauf demande de l'administrateur BloodMoon.


----------------------------------------------------------------------
🧩 ÉTAPE 6 — GRIDCOMMON.INI
----------------------------------------------------------------------

Ouvrez :

    bin/config-include/GridCommon.ini

Repérez la section existante :

    [Modules]

Le module DisplayNameCapsModule doit être activé comme module partagé.

Pour un simulateur où il s'agit du seul module partagé explicitement défini :

    [Modules]
    SharedRegionModules = "DisplayNameCapsModule"

⚠️ IMPORTANT

Si votre simulateur contient déjà d'autres modules partagés personnalisés
dans ce réglage, ne les supprimez pas.

Ajoutez DisplayNameCapsModule tout en conservant la configuration existante.

Ne créez pas une deuxième section [Modules] en doublon.


----------------------------------------------------------------------
🔄 ÉTAPE 7 — RECRÉER LA BASE DES ADD-INS
----------------------------------------------------------------------

Après installation ou remplacement de DisplayNameSimModule.dll, renommez
le cache actuel des add-ins.

Depuis le dossier "bin" :

    mv addin-db-004 \
    "addin-db-004.$(date +%Y%m%d_%H%M%S).bak"

Si "addin-db-004" n'existe pas, passez simplement à l'étape suivante.

Il sera recréé automatiquement au prochain démarrage d'OpenSimulator.


----------------------------------------------------------------------
▶️ ÉTAPE 8 — DÉMARRER LE SIMULATEUR
----------------------------------------------------------------------

Démarrez normalement l'instance OpenSimulator.

L'installation est terminée.

Le simulateur utilisera désormais le service Display Names de BloodMoon.



----------------------------------------------------------------------
🔥 ÉTAPE 9 — CACHE FIRESTORM (TRÈS IMPORTANT)
----------------------------------------------------------------------

Après l'activation du module Display Name sur le simulateur, les utilisateurs
qui s'étaient déjà connectés à BloodMoon avant la mise à jour doivent vider
une fois le cache de Firestorm avant d'utiliser les Display Names.

Sans vidage du cache du viewer, Firestorm peut continuer à utiliser les
anciennes capacités mises en cache et l'option permettant de changer le
Display Name peut rester grisée.

Procédure recommandée :

    1. Se déconnecter de BloodMoon.
    2. Vider le cache de Firestorm.
    3. Fermer complètement Firestorm.
    4. Relancer Firestorm.
    5. Se reconnecter à BloodMoon.

Cette opération n'est normalement nécessaire qu'une seule fois après
l'activation du module Display Names.


----------------------------------------------------------------------
📌 IMPORTANT
----------------------------------------------------------------------

• Utilisez toujours la DLL fournie par BloodMoon.
• Arrêtez toujours OpenSimulator avant de remplacer la DLL.
• Conservez une sauvegarde datée de l'ancienne DLL.
• Recréez "addin-db-004" après remplacement de la DLL.
• Ne modifiez pas les valeurs DisplayNameCaps sans consigne.
• Ne supprimez pas les modules déjà présents dans GridCommon.ini.
• Aucune base de données locale n'est nécessaire.
• La base Display Names et le service web sont gérés par BloodMoon.
• Les utilisateurs Firestorm existants doivent vider une fois le cache du viewer après activation.


======================================================================
BloodMoon Grid — Display Names Module
Installation Guide / Guide d'installation
======================================================================
