Creating pre-made tags

Location of Tags

The tags are found in a folder named "Tags" found within the main script.

Locating the Tags folder

Creating a Tag

We recommend duplicating one of the tags we provide, however make sure you rename the file since that is the name of the tag.

Assignable

["Assignable"] = false,

This determines whether players use the :addtag me TAG_NAME command to add this tag.

This tag cannot be manually given using commands unless changed to true (but you can with the API).

Customization

["Customization"] = {
    ["TagText"] = "STEALING",
    ["TagIcon"] = "7461510428",
    ["TagColor"] = "red",
    ["TagFont"] = Enum.Font.GothamBold,
    ["AutoRemove"] = 30,
},

TagText

The visible text shown on the tag.

Examples

Below is the basic version, just plain text!

["TagText"] = "EXAMPLE",

If you wish to just have an icon, set TagText to false.

["TagText"] = false,

Below is an example of the custom function, you could put any code here!

["TagText"] = function(Player)
    local GroupRank = Player:GetRankInGroup(32675391)
    
    return "RANK " .. tostring(GroupRank) -- RANK 255
end

TagIcon

The image visible on the tag.

Examples

Below is the basic version, just a string!

["TagIcon"] = "7461510428",

If you wish to just have text, set TagIcon to false.

["TagIcon"] = false,

Below is an example of the custom function, you could put any code here!

["TagIcon"] = function(Player)
    local GroupRank = Player:GetRankInGroup(32675391)
    
    if GroupRank >= 200 then
        return "7461510428" -- ADMIN BADGE
    else
        return "71769136630144" -- SMILEY FACE
    end
end

TagColor

The background color of the tag - refers to a color defined in the Colors folder.

Examples

Below is the basic version, just a string!

["TagColor"] = "blue",

Below is an example of the custom function, you could put any code here!

["TagColor"] = function(Player)
    local GroupRank = Player:GetRankInGroup(32675391)
    
    if GroupRank >= 200 then
        return "red" -- ADMIN COLOR
    else
        return "blue" -- MOD COLOR
    end
end

TagFont

Sets the font of the tag text. You can use any font from the Enum.Font list.

Examples

Below is the basic version, just a static font!

["TagFont"] = Enum.Font.GothamBold,

Below is an example of the custom function, you could put any code here!

["TagFont"] = function(Player)
    -- Not sure why you'd want to change the font based on the player...
    -- but you can!
    return Enum.Font.GothamBold
end

AutoRemove

Creates a timer which will automatically remove the tag from the player after the specified amount of seconds.

Examples

AutoRemove can only be a number or false - it does not support custom functions unfortunately.

["AutoRemove"] = false, -- Tag will not automatically remove

["AutoRemove"] = 30, -- Tag will be removed after 30 seconds

OnSpawn

["OnSpawn"] = function(Player)
    return true -- This would always give the tag to everyone
end,

easyNametags v2 does not have any built-in methods for assigning tags (such as entering user IDs or group IDs) - instead you must add code to do so.

We have provided various example pieces of code below, based on what we have commonly been asked about.

Examples

Give tag to people who own a gamepass

["OnSpawn"] = function(Player)
    local GamepassID = 1234567890
    
    local success, response = pcall(function()
        return game:GetService("MarketplaceService"):UserOwnsGamePassAsync(Player.UserId, GamepassID)
    end)
    
    return success and (response == true)
end,

Give tag to people who have a minimum rank OR a gamepass

["OnSpawn"] = function(Player)
    local GroupID = 32675391
    local MinRank = 200
    
    if Player:GetRankInGroup(GroupID) >= MinRank then return true end
    
    local GamepassID = 1234567890
    
    local success, response = pcall(function()
        return game:GetService("MarketplaceService"):UserOwnsGamePassAsync(Player.UserId, GamepassID)
    end)
    
    return success and (response == true)
end,

Give tag to minimum group rank

["OnSpawn"] = function(Player)
    local GroupID = 32675391
    local MinRank = 200
    
    return Player:GetRankInGroup(GroupID) >= MinRank
end,

Give tag to specific group ranks

["OnSpawn"] = function(Player)
    local GroupID = 32675391
    local AllowedRanks = {
        -- Only the specific ranks below get the tag
        50,
        200,
        210,
        215,
        255
    }
    
    local Rank = Player:GetRankInGroup(GroupID)
    
    for _, sRank in pairs(AllowedRanks) do
        if Rank == sRank then return true end
    end
    
    return false
end,

Give tag to specific user IDs

["OnSpawn"] = function(Player)
    local AllowedUsers = {
        1749403537, -- TheMysticalBeat
        1386054378, -- imkirok2
        2567846806, -- Fre22ie
        1521420392, -- zertybee_5
    }
    
    for _, v in pairs(AllowedUsers) do
        if v == Player.UserId then return true end
    end
    
    return false
end,

Something not here which you'd like to-do? Send your configuration to ChatGPT and it can easily do it for you!

If your tag makes API calls or anything which could be slow, we recommend caching the result otherwise it may cause issues.