Augment your game with Nametag+

AwesomePossum212 · January 18, 2021, 10:38pm

Don’t want to read through the post? Get it here now: Releases · AwesomePossum212/nametag-plus · GitHub

About

Nametag+ is designed with the principles in mind:

Performance
Modularity
Contributability

It is designed as a rewrite of my older opensource nametag system with changes to better follow the above principles including

Less polling (but still some as a result of Roblox’s lack of event for a player’s properties loading in)
More versatile and accessible functions for developers
Uses only module scripts
Less intrusive documentation
Open source on GitHub
Licensed under Unlicense

I’m hoping that through these changes, the system will be more usable in professional games, in contrast to the previous system which was intended moreso as a learning resource for beginning developers.

Why beta?
I chose to release it as beta because there is still the possibility of new major changes or features being released; this project is by no means complete (and due to it being open-source could continue to change for a long time). There should not be any bugs; see the contributing section for how to respond if you find one.

Usage

Head over to the releases page at the GitHub repository for Nametag+ to get started. There you can find a list of all released versions past and present. Releases include both a model with just the module (advanced) or a place file with some example implementations (beginner).

Features

Nametag+ includes most of the features from the old system and much more!

100% free to use in your game, no attribution or limitations (read the license for more info).
Automatically link with player health and team color.
All-new Configuration module allows you to efficiently and simply change presets for the entire system, as well as reference those presets throughout your game.
Easily link to a player’s rank in a group
Highly performant and almost entirely event-based.

Contributing

Found a bug? Want to suggest a new feature? Looking to show off how you use Nametag+? Read the Contributing Guide! Do note that any contributions you make will be released irrevocably under Unlicense.

github.com

AwesomePossum212/nametag-plus/blob/main/.github/CONTRIBUTING.md

# Contribution Guide

Thank you for your interest in contributing to Nametag+! If you're confused on how to help out, this guide should hopefully clarify some things for you. If you already know how to use GitHub, you can skip part 1.

**1 - Intro to GitHub**

GitHub is an online codebase software designed for collaborating on development. There are a few key vocab places in this repository that you should be familiar with:
- Code: Where the production codebase is. This shows you the file directory, a preview of the Readme, and allows you to view the code.
- Issues: Here is where you can create a new bug report or specific feature request (with use cases) for Nametag+.
- Pull Requests (PRs): This is where you can go if you'd like to contribute to Nametag+. Once you've forked (cloned) this repository and edited it in a way you think is useful, you can create a PR to indicate that you want to merge your edits into this main repository. Collborators will review your changes and approve or deny your request.
- Discussion: If you need help, want to show off how you're using Nametag+ or want to talk about ideas for the future of Nametag+, you can go here to discuss this with your fellow contributors.

**2 - License notice**

All of the content uploaded to this repository is available for anyone, anywhere to use under the Unlicense license. This means that your contribution(s) will be put into the public domain (or local equivalent) worldwide. Only contribute if you are comfortable releasing your content under this license. Once your changes are committed, you CANNOT restrict usage of it. Now that the boring legal stuff is out of the way (I am not a lawyer and that was not legal advice)...

**3 - Getting started**

So, you think you can improve Nametag+? Here's how to get involved:
- To get started, first, fork the repository to make a linked copy (button at the top right corner of the screen).

This file has been truncated. show original

Feedback

If you have general ideas about how to improve Nametag+, need help with implementation, or want to show off what you’ve made, head over to the discussions page.

Demo

Here’s what it looks like by default. Note that you can change the Configuration module script to make the colors, fonts, and other properties just about anything you want!

You can try out the test place here. Note that it may not necessarily reflect the most up-to-date version of Nametag+.

Messeras · January 19, 2021, 1:45am

Neat system, very cool! I don’t know where I could use this personally, but I know others who could use it.

AwesomePossum212 · January 19, 2021, 2:50am

The main idea of this is to provide a way for developers to add titles and custom designs to nametags that wouldn’t otherwise be possible with Roblox’s default tags. For example, you could:

Add cosmetic titles that a player can display as proof of their achievements
Link the mainStat to a player’s role in a group to show their rank
Show a stat for a player (i.e. wins, points, etc.)
Give players roleplay names

Although the old system was mainly intended for roleplaying groups who wanted a low-tech drag-and-drop solution (in addition to beginning scripters looking to learn Luau), this new system is more focused on providing a more general module for anyone to use in their game.

minkmink · January 19, 2021, 2:54am

cool, it’ll help people who do not know how to create one
albeit i personally will never use this

AwesomePossum212 · February 25, 2021, 8:57pm

v1.0.2 - Display Name Patch

A user recently requested that I add support for the recently released display name project, so I decided to incorporate it as an optional setting. A player’s username is still by default displayed underneath their display name while this is on unless it is overridden with changeTag.

Picture

Info, update guide, files, and more

syreuls · March 1, 2021, 8:42am

Really good nametags, but they sit too high on my head. How can I move them down?

R1EZO · March 1, 2021, 10:23am

i really love thx for make it

AwesomePossum212 · March 1, 2021, 2:54pm

Thanks for catching that! I’ll release a patch for that later today. It should be fairly straight forward, literally only one number in Configuration has to be changed.

github.com/AwesomePossum212/nametag-plus

Nametags are too high above characters

opened 02:53PM - 01 Mar 21 UTC

closed 03:56PM - 08 Mar 21 UTC

AwesomePossum212

**Describe the bug** A user recently noticed that for most characters, the name…tag panel appears unnaturally high above the character's head. **To Reproduce** 1. Go to the [testing place](https://www.roblox.com/games/3956982832/Name-Tag-Testing) 2. Play with a blank character (no hats) 3. Notice the gap between the character and tag **Expected behavior** The tag should only be slightly above the player's head **Screenshots** ![image](https://user-images.githubusercontent.com/60656843/109514211-6769ac00-7a6b-11eb-9561-bf96deb35db5.png) **Additional context** This should be fixed by modifying the default value in Configuration for the billboard gui's ExtentsOffsetWorldSpace property.

EDIT: Pretty sure I just overcompensated for the tag to fit well with my avatar (I wear antlers).

LucasMZ_RBX · March 2, 2021, 1:45am

You should try hiding the @username and fixing the positions when the player’s DisplayName is the same as their username.

AwesomePossum212 · March 2, 2021, 1:59am

I did consider doing that, but I wanted everyone’s name tags to remain consistent so no one is wondering why someone doesn’t have a username name. Note that you can always override the display name manually if you’d like, and the module can be configured not to show display names.

On another note, I will probably not have a patch ready for the two main issues until tomorrow. Sorry for the delay!

AwesomePossum212 · March 8, 2021, 5:12pm

v1.0.3 - Group rank and nametag height patch

Fixed some issues with the recent display name patch. Also changed the default height for the nametag to correct the behavior that @zayeiru spotted. Note that this may cause some visibility issues for some users with large hats. If someone is interested in designing a more dynamic system for determining nametag height, feel free to fork and submit a PR.

Would you be interested in a free-model installer that automatically loads in the latest version using require()?

Yes
No, needs to be more secure
No, I like being able to intuitively fork my own version
No, for another reason (reply or DM me)

0 voters

Note that the GitHub version would still be maintained as the primary method of accessing Nametag+. The free-model would make it easier to update without having to manually copy/paste from GitHub. However, some people may be uncomfortable with a loader executing external code in their game.

aufyre · March 9, 2021, 1:59pm

Hi there, I love these nametags and despite small adding adaptations to suit my game, they have been perfect and not an issue. I was just wondering if at some point you might add a teams/group feature where a user can manually give themselves a nametag by doing a command.

I know I didn’t explain that well so I will give a clearer example. Let’s say you’re in a cafe game and you’re at a training, the host could use a command in order to give people tags such as trainer, supervisor, team a, team b. This is similar to a lot of name commands that come with free admin however ideally I think it would be better if the font could be adapted so fit with the rest of the game.

I am fully aware this would probably be quite a hard feature to programme that may not necessarily fit the audience you currently have, but it’s just a suggestion!

AwesomePossum212 · March 9, 2021, 3:37pm

The best way to do this would be to use .changeTag() and connect it to a chat event to enable the command (or alternatively, if you are already using an admin system that supports custom commands, set it up with that).

local nametagModule = require(game:GetService("ReplicatedStorage"):WaitForChild("NametagModule"))
local nametagConfig = require(game:GetService("ReplicatedStorage"):WaitForChild("NametagModule"):WaitForChild("Configuration"))
local updateRank = function(targetPlayer, rank)
	local tag = nametagModule.getTag(targetPlayer)
	if nametagConfig.options["useDisplayName"] == true then
		nametagModule.changeTag(tag, "ExtraStat", {Text = rank})
	else
		nametagModule.changeTag(tag, "MainStat", {Text = rank})
	end
end)
AdminChattedChangeRankEvent:Connect(updateRank)

Note that the above example requires you to process the chat message and extract the player and rank yourself.

Alternatively, if you don’t want to code a whole lot, changing the player’s team color will outline their name with the team color automatically (assume you are using the default configuration). This could allow you to tag players based on team. If you are interested in testing the behavior, the green block in the testing place demonstrates it.

aufyre · March 11, 2021, 5:52pm

Just tested it and it’s perfect, thank you!

Aymoc · March 24, 2021, 2:52pm

Very cool, Altough there is one thing that i don’t like very much about it. I think that It’s a bit large, but from there, it still looks awesome.

SoMekSlime · May 18, 2021, 4:18pm

Is it possible to give an effect to the chat tags? An example being a recurring rainbow color effect on the players name tag.

AwesomePossum212 · May 18, 2021, 5:14pm

This is an interesting idea. A bit outside the scope of the project, but integrating chat tags would definitely be a useful addition. I’m not an expert on how exactly chat tags work, so I’d probably need to do some more research. I’ve opened an issue on the repo here with more info:

github.com/AwesomePossum212/nametag-plus

Integrate chat tags to use titles

opened 05:13PM - 18 May 21 UTC

AwesomePossum212

[A user recently requested this feature on the DevForum.](https://devforum.roblo…x.com/t/augment-your-game-with-nametag/991893/16?u=awesomepossum212) This would ideally sync chat tags and titles to where calling `.changeTag()` would update the chat tag as well as the titles. This would make it easier for developers to have a one-stop-shop for changing a player's title across multiple locations. However, there are a few barriers to backward compatibility and consistent behavior that need to be addressed: - Need a method to specify chat tag color vs name tag color. I doubt many devs want neon colored name tags, but brighter colored chat tags may be desirable - Need to figure out how to decide which title is sent to the chat tag (i.e. main or extra). With display name options, this gets more complicated, especially for the end user. In order to add some extra non-essential features like this, it may be prudent to start some sort of plugin system that allows developers to create add-on features for Nametag+ without bloating the basic API. However, this will require another feature request to fully address.

Right now it seems like the best option would be to create an add-on to create this behavior because it would be really inconsistent if it was added to the main system.

SoMekSlime · May 18, 2021, 5:20pm

My bad I accidentally said chat tags but meant the Nametags, I use them as titles and would like to give players a selection of title effects, can this be implemented with ease? Apologies for my typo but on a side note integrating chat tags would for sure be useful as well.

WatermelonGUY_YEAH · November 10, 2021, 7:09am

This certainly is possible, though I wouldn’t expect anything to fancy (These are limitations of keeping the codebase manageable).