CustomNameTags

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 10 Open GitHub ↗

This mod provides you with a way to customize your player's name tags completely server-side with no need for any client mods.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# <img src="https://github.com/senseiwells/CustomNameTags/blob/26.2/src/main/resources/assets/custom-nametags/icon.png?raw=true" align="center" width="64px"/> 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.

![nametags.png](https://github.com/senseiwells/CustomNameTags/blob/HEAD/assets/nametags.png?raw=true)

## 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 `"custom-nametags.commands.nametag"`.

#### `/nametag create <identifier> <text>`
This creates a nametag with a given identifier and text, this supports the
[placeholder api](https://placeholders.pb4.eu/user/default-placeholders/).

#### `/nametag delete <identifier>`
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/custom-nametags/config.json`.
The above image used the following configuration:

```json
{
  "nametags": [
    {
      "id": "example:admin_name",
      "update_interval": -1,
      "literal": "[Admin] <rainbow>%player:displayname_visual%<rainbow> ",
      "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: <green>%player:equipment_slot mainhand%</green>",
      "observee_predicate": {
        "type": "negate",
        "value": {
          "type": "entity",
          "value": {
            "equipment": {
              "mainhand": {
                "items": [
                  "minecraft:air"
                ]
              }
            }
          }
        }
      }
    },
    {
      "id": "example:data",
      "update_interval": 1,
      "literal": "%player:health%♥ %player:hunger%🍖 %player:statistic minecraft:killed minecraft:player%⚔ %player:statistic minecraft:deaths%\uD83D\uDC80"
    }
  ]
}
```

### 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/).

#### `"visible_radius"`, `"hidden_radius"`

These two settings specify a range where the nametag will be visible to other players.

Set these to a negative value to disable them.

For example, if you only wanted players in range from a 5.3 to 10.7 block radius to see each others nametags, 
you can set:
```json5
{
  // ...
  "hidden_radius": 5.3,
  "visible_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.

This mod also adds a couple custom predicates for convenience:

A UUID predicate, which matches a player's uuid:
```json5
{
  "type": "uuid",
  "uuid": "d4fca8c4-e083-4300-9a73-bf438847861c"
}
```

A username predicate, which matches a player's username:
```json5
{
  "type": "player_name",
  "name": "senseiwells"
}
```

#### `"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 <team> nametagVisibility never`

CustomNameTags

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README