Aller au contenu
← Toute la documentation

/// PIMPMYRUST PLUGIN

NPC Overlay

Guide des réglages de NPC Overlay pour cette version. Vérifiez la fiche du plugin avant de l'utiliser sur votre serveur.

Préparer votre fichier

  1. Vérifiez la version installée

    Ce guide décrit NPC Overlay 1.0.0. Le configurateur doit utiliser cette même version.

  2. Importez votre configuration

    Ouvrez le configurateur et importez le JSON actuel. Pour une nouvelle installation, vous pouvez partir de l’exemple proposé.

  3. Modifier et exporter

    Ajustez les réglages, corrigez les erreurs signalées et exportez le JSON. Gardez une copie de votre ancien fichier avant de le remplacer.

Votre configuration n’est pas sauvegardée sur le site. Conservez le fichier exporté ; il permet aussi de reprendre plus tard.

Réglages de cette version

Général 1
Labels des PNJ
Valeur JSON

Utilisez le vrai UserIDString du PNJ comme clé. Ceci modifie oxide/data/NpcOverlay.json, pas un fichier oxide/config ; le texte de langue correspondant se maintient séparément.

Chemin JSONOverlays

Instructions du plugin

NPC Overlay — fiche publiée 1.0.0

Affichez un nom ou rôle au-dessus d’un PNJ à l’approche d’un joueur. Le plugin ne crée pas de PNJ, n’ouvre pas Dialogs et ne suit pas les quêtes. La fiche Codefling indique 1.0.0 ; son téléchargement actuel annonce NpcOverlay 1.0.1. Vérifiez le plugin installé avant de suivre ce guide.

Modifier les données d’overlay

Le configurateur modifie oxide/data/NpcOverlay.json. Un nouveau fichier ne contient aucun PNJ.

  1. Dans Overlays, ajoutez un réglage nommé avec le véritable UserIDString fourni par votre plugin PNJ.
  2. Réglez LangKey sur une clé de langue, par exemple npc.bob.role. Ce n’est pas le texte visible par les joueurs.
  3. Ajustez Color et LocalOffset, puis exportez le fichier. Une nouvelle entrée est jaune et placée une unité au-dessus du PNJ ; vérifiez sa couleur et sa position en jeu.

Exemple de l’entrée exportée — utilisez le véritable ID de votre PNJ :

{
  "Overlays": {
    "REPLACE_WITH_REAL_NPC_ID": {
      "LangKey": "npc.bob.role",
      "Color": { "r": 1, "g": 1, "b": 0, "a": 1 },
      "LocalOffset": { "x": 0, "y": 1, "z": 0 }
    }
  }
}

Conservez l’ancien fichier de données avant de le remplacer. L’export ne modifie pas automatiquement votre serveur.

Ajoutez le texte correspondant au fichier de langue NpcOverlay du serveur, par exemple oxide/lang/fr/NpcOverlay.json :

{ "npc.bob.role": "Donneur de quête" }

Utilisez le fichier de langue géré par le framework indiqué ci-dessus, pas oxide/data/lang. Sa clé doit correspondre exactement à LangKey. Ajoutez une traduction pour chaque langue prise en charge.

Fournisseur et vérifications runtime

Votre fournisseur PNJ doit émettre les hooks de proximité avec les objets BasePlayer du PNJ et du joueur. Cette version s’abonne à OnEnterNPC et OnExitNPC, mais nomme son gestionnaire de sortie OnLeaveNPC. Cette incohérence peut empêcher la disparition des libellés. Testez l’entrée et la sortie sur un serveur privé avant utilisation réelle.

Sauvegardez les fichiers de données et de langue, rechargez le plugin, puis vérifiez le texte, la couleur, la position, la traduction et la disparition des libellés. La validation du configurateur contrôle la structure du fichier, pas le bon fonctionnement de votre fournisseur PNJ en jeu.

Installer le fichier

Après avoir conservé une copie de l’ancien fichier, placez le JSON exporté à cet emplacement sur votre serveur :

oxide/data/NpcOverlay.json

Suivez les instructions du plugin ci-dessus pour ses dépendances et son rechargement. L’export ne connecte pas le site à votre serveur.