# Configuration Everything lives in `plugins/NameTag/config.yml`. Edit it, then run `/nametag reload`. There's a `version` at the top. Leave it alone, it's how Name Tag updates your file when you upgrade. ## The main settings | Setting | Default | What it does | |---|---|---| | `can_use_existing_players` | `true` | Whether players can nick as a real Minecraft username. Turn it off and names that exist in Mojang's database are refused | | `should_spoof_uuid` | `false` | Also change the player's UUID to match their nick. **Experimental** | | `allow_cloud_nicking` | `true` | Use Lodestone's service to generate realistic random nicks | **`can_use_existing_players`** is worth thinking about. Left on, someone can convincingly impersonate a real player, which is exactly what you want for an event and exactly what you don't want on a public server where it could be used to impersonate staff. **`should_spoof_uuid`** makes a disguise airtight, but anything that tracks players by UUID (economy, homes, land claims) may lose track of them. Leave it off unless you've tested it against the rest of your plugins. ## Where nicks are stored Set `storage.type` to `LOCAL`, `MONGODB`, `MYSQL` or `MARIADB`. **On a single server, leave it on `LOCAL`.** Nicks go in `plugins/NameTag/data.yml` and there's nothing to set up. **On a network, you need one of the other three**, so every backend server reads the same data and nicks follow players around. See [[Name Tag/Server Owners/Proxy Setup]]. ### Local ```yaml storage: type: "LOCAL" ``` ### MongoDB ```yaml storage: type: "MONGODB" mongodb: uri: "mongodb://localhost:27017" database: "nametag" collection: "players" pool-size: 10 ``` ### MySQL and MariaDB These two take exactly the same settings, so swap `mysql` for `mariadb` and change `type` to match: ```yaml storage: type: "MYSQL" mysql: host: "localhost" port: 3306 database: "nametag" table: "nametag_players" username: "root" password: "" pool-size: 10 use-ssl: false ``` The table is created for you on first start. Turn on `use-ssl` if your database is on another machine. `pool-size` is how many connections Name Tag keeps open. 10 is plenty for most servers. ## Cloud nicking `/randomnick` draws from a pool of real usernames so the nicks it produces look like real people rather than something generated. That pool is built by Lodestone's service, which is what `allow_cloud_nicking` switches on. **What gets sent:** a player's UUID and username when they join, and your server's IP and port so we can track usage. **What doesn't:** nothing about gameplay, no chat, no configuration. If the service is unreachable or you've turned it off, `/randomnick` falls back to a built-in generator. The nicks are less convincing but it keeps working. ## A full example ```yaml version: 6 can_use_existing_players: true should_spoof_uuid: false allow_cloud_nicking: true storage: type: "LOCAL" mongodb: uri: "mongodb://localhost:27017" database: "nametag" collection: "players" pool-size: 10 mysql: host: "localhost" port: 3306 database: "nametag" table: "nametag_players" username: "root" password: "" pool-size: 10 use-ssl: false mariadb: host: "localhost" port: 3306 database: "nametag" table: "nametag_players" username: "root" password: "" pool-size: 10 use-ssl: false ``` ## Related Pages - [[Name Tag/Server Owners/Overview]], what Name Tag does - [[Name Tag/Server Owners/Commands]], every command with examples - [[Name Tag/Server Owners/Proxy Setup]], sharing nicks across a network