NPC Overlay

Give each NPC a visible name, role or short instruction. Help players spot the trader or quest giver, then choose the label's colour and position.

NPC Overlay displays text. Your NPC plugin still handles spawning and interactions.

Labels players can recognise

Use a name such as “Bob — Supplies”, a role such as “Quest giver”, or your own short text. Translations come from the plugin's language files.

With Dialogs, use the same NPC user ID in both plugins. The label points players to the NPC; Dialogs handles the conversation. A label saying “E — Talk” does not bind the E key.

Configure NPC labels on PimpMyRust

Add the real NPC ID, choose its language key, colour and position, then export the data file. Add matching label text to the language file as shown in the guide.

Open the NPC Overlay configurator →

Install it alongside your NPC provider

1. Install NpcOverlay.cs in oxide/plugins.
2. Back up and install the exported oxide/data/NpcOverlay.json.
3. Add the matching text keys to oxide/lang/<language>/NpcOverlay.json.
4. Reload with oxide.reload NpcOverlay and check the labels near your NPCs.

Use the NPC's actual user ID, not a prefab ID. Your NPC provider must send compatible proximity hooks.

Check label removal before live use

The current download has a known leaving-hook mismatch: labels may remain visible after a player leaves the NPC. Check both entering and leaving with your provider.

Setup guide and compatibility details →

For help, use the Codefling Support tab with the installed version, NPC provider and relevant console error.