Skip to content

Home / Plugins / NPC Overlay

// Interface

NPC Overlay

Display a localized 3D label above configured NPCs when players approach.

OxideCarbon

Configure without an account. Install the exported file manually on your server.

PublishedGenerated NPC Overlay artwork illustrating an NPC label

// PRODUCT

What the plugin does

Map NPC identifiers to localized overlay text, an RGBA colour and a local position offset. NPC Overlay reads its settings from oxide/data/NpcOverlay.json, while the text is resolved from the plugin’s language files. It is an independent companion for NPC interaction, not a dialogue or quest system.

  • 01One overlay entry per configured NPC identifier
  • 02Localized label lookup through a language key
  • 03RGBA colour and local XYZ offset
  • 04Edit NPC labels, colours and positions through the Hub

ON PIMPMYRUST

Codefling version 1.0.0 configuration

Import this version’s JSON, edit the settings, and export the finished file.

Keep the exported file: the site does not save your work.

Screenshots

Configuration · 1.0.0

// BEFORE YOU START

Requirements and dependencies.

  • Rust server running Oxide or Carbon
  • An NPC provider emitting OnEnterNPC and matching NPC identifiers
  • Matching language keys in oxide/lang/<locale>/NpcOverlay.json

// IMPORTANT BOUNDARIES

Before you install

  • The Codefling listing says 1.0.0; its current download identifies itself as 1.0.1. Check the installed plugin before following the guide.
  • Test that labels disappear when leaving an NPC. This release uses different exit-hook names (OnExitNPC and OnLeaveNPC), which can prevent labels from being removed.
  • Edit the displayed text in the plugin’s language files, separately from label colours and positions.