NID's Toolbox Light - Chat Tags

Contains Server Chat Tags module for NidToolbox Light server tool-set. Chat Tags appear next to the name of players.

1573-nidtoolbox-design01-nid-64-png

Chat Tags

for NidToolbox Light

requries nid-core module available here

1586-default-violet-2-png

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] :)

NidToolbox's Discord Channel -> here

Chat Tags module allows:

  • Easy creating, granting, revoking and displaying chat tags like: [Admin], [Donor], [Server Owner]
  • 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.
  • Priorities can be assigned to different tags, which should appear first, 0 (zero) being the highest priority.
  • Full integration with Elixir Framework permission Groups! See below for examples.
  • 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.

(click to enlarge)

Requirements:

As any module of NidToolbox set, it requires nid-core version 1.0.3+ module, available here

How to install:

  1. Unpack .zip archive
  2. Copy nid-chattags.dll to Mods\NidToolbox\Modules

Settings files:

Config files are located at:

  1. 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.


Integration with EM Framework:

This module integrates fully and seamlessly with EM Framework.

If you would like to take things on your server to the next level, make sure you utilise EM Framework's permissions system!

Elixir Framework Groups and Permissions module, allows fine and granular control over which player can do what.

Let's say you want your Donors to be able to teleport home and use the teleport command, but you DON'T want the same rights for just the regular users.

Or You want a Moderator group who can ban and mute players but restrict them from spawning items or flying. This is where EM Framework Groups and Permissions come in.

By using /grp-add you can create special permission groups for your Moderators, Donors, Support etc with specifically assigned commands only they can use.

NidToolbox Chat Tags will automatically recognise your EM Groups, their members and will create and assign tags to them all by itself. You can of course still alter colors, visibilty and priority of such tags.

The best thing is - you don't have to download anything, em-framework is included with nid-core download and required by it, so you already have it :)

If you are interested, be sure to check EM Framework documentation page, here.

Available commands:

/help Tags

Displays information about all commands contained within this module.

/tag-add

Creates new player chat tag.


    /tag-add string tagName, string color, int priority, bool visible

    /tag-add Donor, Yellow, 1, true
                    

priority and visibilty are optional. When not defined, priority 1 and visible will be assumed

/tag-show

Displays tag's easily viewable tag configuration in a separate window, including information on who is the tag currently assigned to.


    /tag-show string tagName

    /tag-show Donor
                    

/tag-grant

Assigns tag to the player.


    /tag-grant string tagName, string targetPlayer

    /tag-grant Donor, JonnyBeGood
                    

/tag-revoke

Remove tag from the player.


    /tag-revoke string tagName, string targetPlayer

    /tag-revoke Donor, JonnyBeGood
                    

/tag-color

Assigns color to the selected tag.


    /tag-color string tagName, string color

    /tag-color Donor, Orange
                    

/tag-del

Removes specified player chat tag.


    /tag-del string tagName

    /tag-del Donor
                    

/tag-rename

Renames existing tag.


    /tag-rename string tagName, string newName

    /tag-rename Donor, VIP
                    

/tag-pri

Assigns priority to the selected tag.


    /tag-pri int priority

    /tag-pri 1
                    

/tag-config

Configures targeted chat tag.


    /tag-config string tagName, string color, bool visible, int priority

    /tag-config Donor, Green, true, 2
                    

/tag-list

Lists all created tags.


    /tag-list
                    

/tag-reload

Reload settings from config files.


    /tag-reload
                    

Current Version: 1.0.1

Supported Eco Version: 9.2.x

Download Docs

Changelog

How To Install


Would you consider supporting NID as he brings you more content and continuesly updates his modkit?

Support NID


Need more help? Join NID's

Elixr Mods DiscordDiscord!