SCNicknamer Documentation

Example

{
    "whitelist": ["my.coolserver.com", "another.coolserver.com", "173.233.142.94"],
    "mappings": {
        "68cccf6e-5cc2-495f-a860-43bdc67e847d": {
            "mc_name": "ExampleIGN",
            "mc_uuid": "68cccf6e-5cc2-495f-a860-43bdc67e847d",
            "nickname": "A Nicer Name!",
            "colour": "ff4f00",
            "colours": ["ff4f00", "ff0000"]
        },
        "ca7ed03d-06dd-4563-aa5e-43ba79e5a64b": {
            "mc_name": "MinecraftName",
            "mc_uuid": "ca7ed03d-06dd-4563-aa5e-43ba79e5a64b",
            "nickname": "A nickname"
        },
        "2b585cdc-28aa-45a1-9532-4fb4b35a13ec": {
            "mc_name": "AnotherPlayer",
            "mc_uuid": "2b585cdc-28aa-45a1-9532-4fb4b35a13ec",
            "colour": "ff4f00"
        }
    },
    "blacklist": [],
    "messages": [],
    "version": 2
}

whitelist

List of strings. Optional.
A list of server IPs to enable the mod on. If not provided or empty, the whitelist feature is disabled.

"whitelist": ["my.coolserver.com", "another.coolserver.com", "173.233.142.94"]

mappings

Object mapping UUIDs to JSON objects. Required.

"mappings": {
    "68cccf6e-5cc2-495f-a860-43bdc67e847d": {
        "mc_name": "ExampleIGN",
        "mc_uuid": "68cccf6e-5cc2-495f-a860-43bdc67e847d",
        "nickname": "A Nicer Name!",
        "colour": "ff4f00",
        "colours": ["ffff00", "ff4f00", "ff0000"]
    }
}

mc_name

A string. Required.
The player's Minecraft username.

"mc_name": "ExampleIGN"

mc_uuid

A string. Required.
The player's Minecraft UUID as a string. If dashes are included they must be in the correct places.

"mc_uuid": "68cccf6e-5cc2-495f-a860-43bdc67e847d"

nickname

A string. Optional.
The nickname to potentially replace the player's name with or show in chat. If not provided, this player's name will not be replaced.

"nickname": "A Nicer Name!"

colour

A string. Optional.
A single colour to associate with the player. '#' should not be included. If not provided, the player's name will never be coloured. If colours is provided, this is only used for the locator bar.

"colour": "ff4f00"

colours

A list of Strings. Optional.
A gradient to colour the player's name with. Does not need to match colour.

"colours": ["ffff00", "ff4f00", "ff0000"]

blacklist

Not currently used. May be used with future server whitelist/blacklist functionality.

messages

Not currently used. May be used with future message flashing functionality.

version

Not currently used. If included, should be set to 2.

"version": 2