NidToolbox: Chat Tags Module

[plugin logo small header]Chat Tags module for NIDTOOLBOX Light

[kofi button blue]

Compatible with ECO 13+

NEW - if you would like to have YOUR SERVER LOGO appear in the notifications area in messages that come from NidToolbox. Please join my DISCORD and post them in #server-logos channel.

Create and assign CHAT TAGS to the players on your server, to clearly mark their roles and membership, whether they are an [ADMIN] or a [JANITOR] [:)]

SUPPORT IS PROVIDED as well as SUGGESTIONS ARE ACCEPTED on my DISCORD [DISCORD TINY] HERE

FUNCTIONALITY

---

• Easy creating, granting, revoking and displaying chat tags like: [ADMIN], [DONOR], [SERVER OWNER]
• FORCE and CHANGE COLOR of the USER NAME / user string
• CAN BE VISIBLE IN TOOLTIPS!
• Chat Tags are now INTERACTIVE within the game UI, have DESCRIPTIONS and show TOOLTIP on hover.
• SELF-ASSIGNABLE TAGS can be configured - special type of tags - these can be self-assign by your server players (i.e. pronouns etc).
• Fully customizable! ANY COLOUR of choice CAN BE DEFINED. Module accepts either ANY HEX COLOUR CODE or provided 16 DEFINED NAMED COLOURS options for ease of use.
• Formatting options include: BRACKETS TYPE, BRACKET COLOR, SIZE, ITALIC, UNDERLINE, UNDERLINE COLOR.
• Tags can have shorter forms, like [DR], for [DONOR] etc. Configurable via TextInUI and TooltipText properties, or tag-Tooltip and tag-UI commands.
• Possible to force custom capitalisation of the name.
• PRIORITIES CAN BE ASSIGNED to different tags, which should appear first, 0 (zero) being the highest priority.
• Easy CONFIGURATION VIA IN-GAME COMMANDS.
• Configuration can be viewed at any time, with LOOKS EXAMPLE as well as TAG MEMBERSHIP.
• Module CAN BE RELOADED AT ANY TIME, without the need of a server restart.

[cht tgs 1 min]

[cht tgs 3 min]

REQUIREMENTS

---

As any module of NidToolbox set, it requires NID-CORE VERSION 1.0.3+ module, available in the MAIN FORUM THREAD: here

INSTALLATION

---

• Unpack .zip archive
• COPY nid-chattags.dll to MODS\NIDTOOLBOX\MODULES
• Configuration files will be created after first run and are located in \Configs\Mods\NidToolbox

SETTINGS

---

Config files are located at:

• CONFIGS\MODS\NIDTOOLBOX\CHATTAGS.JSON - contains module settings.

CONFIGURATION

---

Chat tags are created and configured via usage of in game commands. While there is a settings file available as well, I strongly discourage from editing it by hand.

There are currently TWO TAG TYPES:

• MANUAL - this is SIMPLEST CHAT TAG, can be created, deleted, renamed, formatted AT ANY TIME and ASSIGNED FREELY.
• EMGROUP - this chat tag is CREATED AUTOMATICALLY, based on EXISTING ELIXIR FRAMEWORK PERMISSION GROUPS and protected from deletion or renaming. Its COLOUR, PRIORITY and VISIBILITY can be ASSIGNED FREELY, however MEMBERSHIP IS READ DIRECTLY form the EM GROUPS created by server admins. See below for some example integrations with EM permission groups. Some of the system tags as Admin and Default are also defined as this type of tag.
• (upcoming) DEMOGRAPHIC - it is an upcoming chat tag type, that will be assigned automatically to the members of the specified demographic. Its visibility, priority and colour will also be freely editable.

ADDING NEW TAG is as simple as issuing /TAG-ADD and specifying the details. Only tag name and color are required, priority of 1 and visibility enabled are assumed if not given by the issuer.

TAGS CAN BE ASSIGNED by issuing /TAG-GRANT and stating a player name. After that tag will be always added to the targeted user.

HOW TO VIEW TAG'S SETTINGS - to check tag's settings at glance, simply issue /TAG-SHOW tagName. It will trigger a window, showing all the settings for the tag, including MEMBERS, COLORS, TYPE and LOOK EXAMPLE.

PRIORITY - normally tags are shown in the alphabetical order. If you would like to alter this behaviour, for example to SIGNIFY SOME IMPORTANT ROLES LIKE DONORS and SERVER SUPPORTERS, you can assign priority to the tag in question. Tags with higher priority will show first. Highest priority available is 0 (zero). Tags with same priority will respect alphabetical order.

Use /TAG-PRI tagName, priority to change tag's priority.

VISIBILITY - all created tags start as visible, however if you need to hide tag for some reason, you don't need to delete it. Just hide it's visibility! Visibilty can be change via /TAG-CONFIG command.

FORMATTING

Bracket types, bracket colors, italic, underline and underline colors and size can all be applied as per the user liking. See below for details (in commands section).

Let's say you have created a player tag - MY SUPPORTERS but instead of using the default [ ] brackets, you prefer < > type. Use /TAG-BRACKETS to alter them.

You can also FORCE SPECIFIC CAPITALISATION of the tag.

COMMANDS

---

/HELP TAGS

Displays information about all commands contained within this module.

/TAG-PLAYERCOLOR

Changes player color (user string) in game UIs.

/TAG-PLAYERCOLOR User targetUser, string color

Code

/TAG-PLAYERCOLOR targetUser, color

/TAG-PLAYERCOLORDEL

Removes previously set player user string color.

/TAG-PLAYERCOLORDEL User targetUser

Code

/TAG-PLAYERCOLORDEL targetUser

/TAG-PLAYERCOLORSHOW

Shows current color of the player string.

/TAG-PLAYERCOLORSHOW User targetUser

Code

/TAG-PLAYERCOLORSHOW targetUser

/TAG-PLAYERCOLORLIST

Shows list of player with altered color player strings

/TAG-PLAYERCOLORLIST

Code

/TAG-PLAYERCOLORLIST

/TAG-PLAYERCOLORCLEAR

Clears all altered colors from all players.

/TAG-PLAYERCOLORCLEAR

Code

/TAG-PLAYERCOLORCLEAR

/TAG-ENABLESELFSYSTEM

Enables or disables self tagging system for your users.

/TAG-ENABLESELFSYSTEM bool true/false

Code

/tag-EnableSelfSystem true/false

/TAG-MAKESELFASSIGNED