Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/senseiwells/customnametags
This mod provides you with a way to customize your player's name tags completely server-side with no need for any client mods.
https://github.com/senseiwells/customnametags
custom-name-tags minecraft mod server-side
Last synced: about 2 months ago
JSON representation
This mod provides you with a way to customize your player's name tags completely server-side with no need for any client mods.
- Host: GitHub
- URL: https://github.com/senseiwells/customnametags
- Owner: senseiwells
- License: mit
- Created: 2023-11-28T22:24:17.000Z (about 1 year ago)
- Default Branch: 1.20.2
- Last Pushed: 2024-09-12T18:54:14.000Z (3 months ago)
- Last Synced: 2024-09-13T08:32:35.027Z (3 months ago)
- Topics: custom-name-tags, minecraft, mod, server-side
- Language: Kotlin
- Homepage:
- Size: 693 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
CustomNameTags
This mod provides you with a way to customize your player's
name tags completely server-side with no need for any client mods.
## Commands
You are able to do some basic actions from within the game with the `/nametag`
command, this requires permission level 2 or if you are using a permissions mod
you can have the permission `"customnametags.command.nametag"`.
#### `/nametag create `
This creates a nametag with a given identifier and text, this supports the
[placeholder api](https://placeholders.pb4.eu/user/default-placeholders/).
#### `/nametag delete `
This deletes a given nametag with identifier.
#### `/nametag reload`
This reloads the config file.
## Configuration
This mod allows a high level of customization, from the text being
displayed, whether it is being displayed and who it can be displayed to.
All of this is configured using a json located in `config/CustomNameTags/config.json`.
The above image used the following configuration:
```json
{
"name_tags": [
{
"id": "example:admin_name",
"update_interval": -1,
"literal": "[Admin] %player:displayname_visual% ",
"observee_predicate": {
"type": "operator",
"operator": 4
}
},
{
"id": "example:name",
"update_interval": -1,
"literal": "[Player] %player:displayname_visual%",
"observee_predicate": {
"type": "negate",
"value": {
"type": "operator",
"operator": 4
}
}
},
{
"id": "example:held_item",
"update_interval": 1,
"literal": "Holding: %player:equipment_slot mainhand%",
"observee_predicate": {
"type": "negate",
"value": {
"type": "entity",
"value": {
"equipment": {
"mainhand": {
"items": [
"minecraft:air"
]
}
}
}
}
}
},
{
"id": "example:data",
"update_interval": 1,
"literal": "%player:health%♥ 20🍖 %player:statistic minecraft:killed minecraft:player%⚔ %player:statistic minecraft:deaths%\uD83D\uDC80"
}
]
}
```
* Note about the example above `"%player:hunger%"` is supposed to come after the player health,
however due to a bug in the playerholder api this is not working correctly for the time being.
### Creating a Nametag
In the config json, there will be an array which contains all the nametags
that will be displayed for your players. Each nametag is its own object.
Let's have a look at what makes up a nametag:
#### `"id"`
This is the identifier unique to your nametag, and follows this convention:
`"namespace:name"`.
#### `"update_interval"`
This is the interval at which the nametag will be updated, in ticks.
Set to -1 if your nametag doesn't need to be updated.
#### `"literal"`
This is the text that will be displayed on your nametag. This supports
the [placeholder api](https://placeholders.pb4.eu/user/default-placeholders/),
which means you can add contextual data.
For example `"%player:displayname"` which will insert the display name of the current player.
For all the details reference the [placeholder api](https://placeholders.pb4.eu/user/default-placeholders/).
#### `"view_radius"`
This specifies a radius (in blocks) at which the nametag will be visible to other players.
Set this to a negative value to have an unbounded view radius.
For example, if you only wanted players within a 10.7 block radius to see eachothers nametags you can set:
```json5
{
// ...
"view_radius": 10.7,
// ...
}
```
#### `"observee_predicate"`
This is optional and doesn't need to be defined, but if defined will allow
you to decide which players will have this given nametag.
For example, in the example, above only operators are given the `"example:admin_name"`
nametag and only non-operators are given the `"example:name"` nametag.
This uses the [predicate api](https://github.com/Patbox/PredicateAPI/blob/1.20.2/BUILTIN.md);
you can view the documentation for more details about what predicates you
can define.
#### `"observer_predicate"`
This is optional and doesn't need to be defined, but if defined will determine
whether an observing player will be able to see this nametag.
This uses the [predicate api](https://github.com/Patbox/PredicateAPI/blob/1.20.2/BUILTIN.md);
you can view the documentation for more details about what predicates you
can define.
# Caveats
There are some limitations of CustomNameTags, while for almost all the cases
the nametags will behave as expected, there are inconsistencies with the
custom nametags.
- When players press F1 to hide their HUD player custom nametags will remain visible.
- If the player is part of a team, their normal nametag will render.
- This can be solved by hiding all nametags for the given team:
- `/team modify nametagVisibility never`