Config

Explanation of Hoa NameTag Config

Config = {}

Config.Notify = 'ox' -- qb, ox

-- General
Config.UseNameSettingMenu = true
Config.OnlySameJobVisible = false
Config.AllowNameToggleCommand = true
Config.ChangeScaleDistance = true
Config.NameVisibleDistance = 10.0
Config.ThroughObjectVisible = false
Config.InVehicleVisible = false
Config.FirstJoinVisible = true
Config.TextOutline = true

-- NameTag
Config.AllowNameChange = true
Config.UseServerName = true
Config.AllowToggleNameTag = true
Config.AllowChangeNameColor = true
Config.NameScale = 0.6
Config.NameHeight = 0.15
Config.NameOrder = false

-- SubTag
Config.AllowSubTag = true
Config.AllowChangeSubTagColor = true
Config.SubTagScale = 0.4
Config.SubTagHeight = 0.18

-- GangName
Config.AllowToggleGangVisible = true
Config.AllowGangName = true
Config.GangFormat = '<%s>'
Config.GangScale = 0.35
Config.GangHeight = 0.11
Config.GangVisibleLimit = 'gang'
-- 'all'
-- 'gang'
-- 'same'
Config.NoGangLabel = 'No Gang'

-- Badge
Config.AllowBadge = true
Config.BadgePosition = 'right' -- left, right
Config.Badges = {
    Beginner = '🔰',
    Streaming = '📡',
    Mute = '🔇'
}
Config.FirstBadge = 'Beginner'

-- ID
Config.IdVisible = true
Config.IdPosition = 'left' -- left, right
Config.IdFormat = '[%s]'

-- Experimental
Config.TalkName = true

General

Config.UseNameSettingMenu

Whether to allow the use of the name setting UI.

Disabling this will make most features unusable.

Config.OnlySameJobVisible

Whether to display names only to people in the same job or gang.

Enabling this will make names visible only to those who share the same job or belong to the same gang.

Config.AllowNameToggleCommand

Whether to allow toggling name display using the /name command.

Config.ChangeScaleDistance

Whether to adjust the name size based on distance.

If enabled, for example, name tags of players who are far away will appear smaller, and those who are close will appear larger.

If disabled, you will need to manually set the scale and height again. Leaving it at the default will make the name scale too large.

Config.NameVisibleDistance

The maximum distance at which names are displayed.

Setting this too high will increase the load on both the server and client.

Config.ThroughObjectVisible

Whether to display names through objects.

If disabled, names will be hidden when there is an obstacle between yourself and other players.

Config.InVehicleVisible

Whether to display names while inside a vehicle.

If disabled, names will not be shown when players are inside vehicles.

This is to prevent name tags from lagging behind due to the speed of the vehicle.

Config.FirstJoinVisible

The default name display state when joining for the first time.

If enabled, names will be shown upon a player's first join.

“First join” here means when there is no existing data for that player in the database.

Config.TextOutline

Whether to display an outline around the name.

Enabling this improves the visibility of the name tag.

NameTag

Config.AllowNameChange

Whether to allow name changes.

This controls permission for changing names via the /name command and through the UI.

If disabled, name changes via /name and input in the UI name field will be blocked.

Config.UseServerName

Whether to directly change the server-side name when changing the name.

If enabled, the character’s configured name will be changed directly.

If disabled, the name will be saved only in the database and displayed on the name tag. Therefore, names used for billing or item grants will not be changed.

Config.AllowToggleNameTag

Whether to allow toggling the display of individual names.

This setting controls permission for toggling names within the UI only and is not related to the /name command.

Config.AllowChangeNameColor

Whether to allow changing the name color.

If enabled, changing the name color via the UI is permitted.

If disabled, pressing the color change button in the UI will have no effect.

Config.NameScale

The size at which the name is displayed.

Config.NameHeight

The height at which the name is displayed.

Config.NameOrder

Whether to reverse the order of the name.

When disabled, the order is <firstname> <lastname>. When enabled, it becomes <lastname> <firstname>.

SubTag

Config.AllowSubTag

Whether to allow the use of sub-tags.

If enabled, sub-tags can be edited through the UI.

If disabled, the sub-tag input field in the UI will be disabled, and sub-tags will not be displayed on the name tags.

Config.AllowChangeSubTagColor

Whether to allow changing the color of sub-tags.

If enabled, changing the sub-tag color via the UI is permitted.

If disabled, pressing the color change button in the UI will have no effect.

Config.SubTagScale

The size at which the sub-tag is displayed.

Config.SubTagHeight

The height at which the sub-tag is displayed.

GangName

Config.AllowToggleGangVisible

Whether to allow toggling the display of gang names.

If enabled, toggling the gang name display via the UI will be disabled.

Config.AllowGangName

Whether to allow the use of gang names.

If enabled, gang names can be edited through the UI.

If disabled, the gang name input field in the UI will be disabled, and gang names will not be displayed on the name tags.

Config.GangFormat

Gang name format.

Be sure to include %s somewhere in the format; otherwise, the gang name will not be displayed.

Also, if you use special characters such as <, >, &, ", or ', they must be replaced with escape characters.

Main special characters and their escape characters

Config.GangScale

The size at which the gang name is displayed.

Config.GangHeight

The height at which the gang name is displayed.

Config.GangVisibleLimit

Who the gang name is displayed to.

Changing this setting allows you to restrict who can see the gang name.

value
person

all

All players

gang

Only those who belong to the gang

same

Only members of the same gang

By default, the gang name is displayed only to members of the same gang.

Config.NoGangLabel

Default label for the gang name.

In the code, players’ gang membership is managed based on this label, so if you have changed the default gang label, please update it here accordingly.

Badge

Config.AllowBadge

Whether to allow the use of badges.

If enabled, badges can be edited through the UI.

If disabled, the badge section in the UI will be disabled, and badges will not be displayed on the name tags.

Config.BadgePosition

Badge display position.

This sets whether badges are shown on the left or right side.

By default, badges are displayed on the right side.

Config.Badges

Register badges.

The badges entered here will be available for users to use.

When adding badges, please set them the same way as the other badges.

BadgeName = 'Badge'

Config.FirstBadge

Select the badge for first-time participants.

Here, please enter the badge name, not the badge itself.

ID

Config.IdVisible

Whether to display the ID.

If disabled, the ID will no longer be shown next to the name.

Config.IdPosition

ID display position.

This sets whether the ID is shown on the left or right side.

By default, the ID is displayed on the left side.

Config.IdFormat

ID format.

Be sure to include %s somewhere in the format; otherwise, the ID will not be displayed.

Also, if you use special characters such as <, >, &, ", or ', they must be replaced with escape characters.

Main special characters and their escape characters

Experimental

Config.TalkName

Whether to change the name color when a player is speaking.

This is an experimental feature.

If enabled, the name will glow when the player is speaking.

However, even if the player is muted (range set to 0), it will still be detected as speaking, so the color will change.

Main special characters and their escape characters

Special characters
Escape characters

<

&lt;

>

&gt;

&

&amp;

"

&quot;

'

&apos;

PreviousDatabaseNextCommands

Last updated