Settings
tm_music has no config file. Every option is a setting with its default in code, saved in the database and edited in game: open the admin panel with /tmadmin and choose Music. Changes apply at once unless a setting says it needs a restart. Only players with the tm_lib admin permission can edit them.
Settings marked server are never sent to players.
General
| Setting | Default | Description |
|---|---|---|
| Command | music | A short chat command for the player, next to /tm:music which always exists. Empty for none. Needs a restart. |
| Vehicle radio command | carradio | A short chat command for the vehicle radio, next to /tm:carradio. Empty for none. Needs a restart. |
| Default volume | 50 | Volume a new booth, speaker or player starts at. |
Speakers
| Setting | Default | Description |
|---|---|---|
| Phone speaker range | 5 | How far, in meters, music from a phone speaker carries. |
| Connect range | 25 | How close a player must be to connect a device to booth speakers. |
| Booth speaker range | 25 | How far a booth speaker carries. Applies to booths created afterward. |
| Linked speakers | 4 | How many extra speakers one device can link to its connection. |
| Take over request time | 30 | Seconds a request for control waits for an answer. |
| Control point radius | 1.2 | Size of the spot a player uses to open a booth. |
Vehicle radios
| Setting | Default | Description |
|---|---|---|
| Vehicle radios | Every vehicle | Off, installed by other scripts, or every vehicle. |
| Vehicle radio range | 8 | How far a vehicle radio carries outside the car. |
| Vehicle connect range | 12 | How close a player must be to a vehicle to use its radio. |
Station radio
| Setting | Default | Description |
|---|---|---|
| Stations | empty | One station per line as `Name |
YouTube search
Searching runs on the server so the key never reaches a player. Create a YouTube Data API v3 key in Google Cloud and set it in a private config file:
set tm_music_youtube_api_key "your key"The official API costs 100 quota units per search against a default 10,000 a day, about 100 uncached searches. Identical searches are cached and each player is limited. With no key the Invidious instances below are tried instead. Those are public and can be slow or down, so use a key on a live server. Only embeddable videos are returned.
| Setting | Default | Description |
|---|---|---|
| Search | on | Lets players search from the player. |
| Results per search | 12 | How many videos a search returns. |
| Music category only | on | Limits official API results to the Music category. |
| Cache time | 360 | Minutes an identical search is answered from memory. |
| Search cooldown | 2 | Seconds a player waits between searches. |
| Searches per hour | 40 | Uncached searches per player per hour, so one player cannot drain the quota. |
| Invidious instances (server) | three public ones | One address per line, tried in order when no key is set. |
Phone app
| Setting | Default | Description |
|---|---|---|
| Phone | Detect automatically | Which phone gets the app: lb-phone, NPWD, a custom adapter or none. Needs a restart. |
| App name | Music | Name under the app icon. Needs a restart. |