> For the complete documentation index, see [llms.txt](https://lng.gitbook.io/lng-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lng.gitbook.io/lng-docs/simple-name-tags/readme.md).

# Welcome to Simple Name Tags

Welcome to the official documentation for Simple Name Tags.

*Finally, name tags that actually work—and look good doing it.* This mod has evolved from a basic script into a fully configurable, feature-rich identity system. It is designed to be highly optimized and crash-proof, featuring soft-dependency architecture that integrates seamlessly with other mods like Expansion Hardline without requiring hard links that cause server crashes.

***

### ✨ Core Features

* 🧟 Creature & Zombie Tags: You can now assign custom name tags to AI entities! Give specific boss zombies custom names, levels, and colors, or let the system automatically pull their vanilla names.
* 🎙️ Voice Integration: A dynamic microphone icon appears and lights up green when a player is actively talking (fully Push-to-Talk compatible).
* 💤 Automated AFK System: Players are automatically marked as `[AFK]` (in red) and their rank icons are hidden if they haven't moved for a set time, reducing screen clutter.
* 🤝 Expansion Hardline Sync: Automatically detects Expansion Hardline and displays the player's Reputation value right next to their name. No hard dependency required!
* 🎖️ Ranks & Reputation: Assign custom icons (Vanilla or Modded) and Star Ratings (1-5 Stars) to specific players via their SteamID.
* 🎭 Unlimited Custom Tags: Create custom roles (e.g., `[OWNER]`, `[MEDIC]`, `[VIP]`) with unique hex colors and assign them to your community members.
* 🕵️ Admin Incognito Mode: Admins can press `Ctrl + H` to toggle their tag completely OFF. Your tag becomes invisible to players, but turns grey on your screen so you know stealth is active.
* 🔄 Live Auto-Reloading: The server can be set to automatically reload the config every X minutes, or admins can manually press `Ctrl + N` to live-reload tags without restarting the server.
* 🛡️ Crash-Proof Configs: Our built-in "Auto-Patcher" detects outdated config files and automatically updates them with new features. You never have to delete or wipe your config after a mod update.

***

### ⚠️ PvP vs. PvE Server Warning

This mod was primarily designed for PvE and Co-op servers where identifying friends quickly is more important than absolute stealth.

For PvP Server Owners:

Simple Name Tags utilizes a "Smart Raycast Filter" that stops tags from showing through solid walls and terrain. However, to prevent the frustrating "flickering" found in other mods, it is designed to see through "soft" objects like bushes, grass, and invisible mod triggers (like Safezones). This means it may occasionally reveal a player hiding in dense foliage.

> 💡 Recommendation for PvP: We highly recommend lowering the `MaxDistance` in your configuration to 10m - 20m (Default is 50m). This simulates realistic "face recognition" rather than long-range spotting.

***

### 📁 Installation & File Migration

1. Copy the `@SimpleNameTags` folder to your server directory.
2. Copy the `.bikey` file from the `Keys` folder to your server's `Keys` folder.
3. Add `-mod=@SimpleNameTags` to your server start parameters.

Important Note for Existing Users:

The configuration files have migrated! Upon your first run, the mod will automatically move your old files to the new unified studio folder:

`$profile:LNGStudio/SimpleNameTags/`

***

### 📖 Documentation Navigation

Select a section below to start configuring your tags:

#### ⚙️ The Configuration Guide

*(Link to next page)*

The complete breakdown of the `SimpleNameTagsConfig.json` and `CreaturesTags.json`. Learn how to set up your layout styles, assign SteamIDs, and configure the AFK timers.

***

*Special Thanks to @Lufson for the great ideas and feedback used to improve this mod!*

***

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-bolt">:bolt:</i></h4></td><td>SimpleNameTags<strong>Config.json</strong></td><td>Navigate the commented config</td><td></td><td></td><td><a href="/lng-docs/simple-name-tags/getting-started/profilesold-lngstudio-simplenametags-simplenametagsconfig-json.md">profilesOLD\LNGStudio\SimpleNameTags\SimpleNameTagsConfig.json</a></td></tr><tr><td></td><td>CreatureTags.json</td><td>Navigate the commented config</td><td></td><td></td><td><a href="/lng-docs/simple-name-tags/getting-started/profilesold-lngstudio-simplenametags-creaturestags-json.md">profilesOLD\LNGStudio\SimpleNameTags\CreaturesTags.json</a></td></tr></tbody></table>