/// PIMPMYRUST PLUGIN
NPC Overlay
Settings guide for this version of NPC Overlay. Check the plugin page before using it on your server.
Prepare your file
- Check the installed version
This guide describes NPC Overlay 1.0.0. Use the same version in the configurator.
- Get the settings
Click Import, then From my server. Select the files and confirm loading them. Selecting a server does not replace the open document. You can also import files from this device or a configuration from My projects.
- Edit and send
Adjust settings, fix errors, then use Send to transfer files to the selected server. A conflict blocks sending until you choose how to resolve it. You can still export only the files you need.
Server transfers have private backups. Save keeps your work in My projects; it does not send anything to the server. A download also lets you resume without a server connection.
Settings for this version
General 1
- NPC overlays
- JSON value
Use the real NPC UserIDString as each entry key. This edits oxide/data/NpcOverlay.json, not an oxide/config file; the matching language text is maintained separately.
JSON path
Overlays
Plugin instructions
NPC Overlay — published listing 1.0.0
Show a name or role above an NPC when a player approaches. The plugin does not create NPCs, open Dialogs or track quests. The Codefling listing says 1.0.0; its current download identifies itself as NpcOverlay 1.0.1. Check the installed plugin before following this guide.
Edit the overlay data
The configurator edits oxide/data/NpcOverlay.json. A new file has no NPC entries.
- In
Overlays, add a setting named with the real NPCUserIDStringsupplied by your NPC plugin. - Set
LangKeyto a language key, for examplenpc.bob.role. This is not the text players will see. - Adjust
ColorandLocalOffset, then export the file. A new entry defaults to yellow, one world unit above the NPC; verify its colour and position in game.
Example of the exported entry — use your actual NPC ID:
{
"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 }
}
}
}Keep a copy of the old data file before replacing it. Exporting does not change your server automatically.
Add the matching text in the server’s NpcOverlay language file, for example oxide/lang/en/NpcOverlay.json:
{ "npc.bob.role": "Quest giver" }Use the framework-managed language file shown above, not oxide/data/lang. The key must match LangKey exactly. Add translations to each language you support.
Provider and runtime checks
Your NPC provider must send the proximity hooks with the NPC and player BasePlayer objects. This release subscribes to OnEnterNPC and OnExitNPC, but names its leaving handler OnLeaveNPC. That mismatch can prevent labels from being removed. Test both entering and leaving on a private server before live use.
Back up the data and language files, reload the plugin, then verify the text, colour, position, language and label removal. Validation in the configurator checks the file structure, not whether your NPC provider works correctly in game.
Install the files
With a connected server, click Send in the configurator. The result shows whether the files were sent and the plugin reloaded. Without RCON, reload the plugin from your server panel after sending.
Without a connected server: Keep a copy of the current files. Place each export in the folder shown before export, or follow the paths in the ZIP. Do not put data or translation files in the config folder.
Follow the plugin instructions above for dependencies and reloading. Exporting does not connect the site to your server.