You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/server/headless.mdx
+33-3Lines changed: 33 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -111,8 +111,8 @@ services:
111
111
AvatarPassword: ""
112
112
volumes:
113
113
- Basis:/root/.config/unity3d/Basis Unity/Basis Unity # For Sharing Cached files. If running on Windows you should do it this way.
114
-
- "${APPDATA}/../LocalLow/Basis Unity/Basis Unity:/root/.config/unity3d/Basis Unity/Basis Unity"# If you want to use your own cache and avatar files. Slower on Windows as its having the overhead from WSL2 *Corruption possible
115
-
- ./config.xml:/app/HeadlessLinuxServer_Data/config.xml # Optional will be overridden when using environment variables
114
+
#- "${APPDATA}/../LocalLow/Basis Unity/Basis Unity:/root/.config/unity3d/Basis Unity/Basis Unity" # If you want to use your own cache and avatar files. Slower on Windows as its having the overhead from WSL2 *Corruption possible
115
+
#- ./config.xml:/app/HeadlessLinuxServer_Data/config.xml # Optional will be overridden when using environment variables
@@ -145,7 +145,7 @@ The examples above use the minimum values needed to connect:
145
145
146
146
| Variable | Purpose |
147
147
|----------|---------|
148
-
| `IP` | Hostname or IP address of the Basis server |
148
+
| `Ip` | Hostname or IP address of the Basis server |
149
149
| `Port` | UDP port the server listens on, usually `4296` |
150
150
| `Password` | Server password required to join |
151
151
| `HealthCheckEnabled` | Enable or Disable HealthCheckEndpoint |
@@ -154,9 +154,39 @@ The examples above use the minimum values needed to connect:
154
154
| `HealthPath` | Path for Health info |
155
155
| `AvatarFileLocation` | Combined URL support of avatar#base64 |
156
156
| `AvatarPassword` | Avatar password |
157
+
| `StrictMemoryCleanupEnabled` | Remove all textures that are loaded |
157
158
158
159
If you mount a `config.xml`, treat it as the file-based fallback configuration. If you also set environment variables, the docs for the main server note that environment values override xml values, so keep one source of truth where possible to avoid confusion during testing.
159
160
161
+
## Optional Voice Simulation with AudioClips
162
+
163
+
Headless clients can optionally simulate microphone traffic by streaming a `.wav` or `.opus` file as voice audio.
164
+
165
+
Basis checks the `AudioClips` folder inside the headless player's data directory during startup. If one or more files are present, the headless client randomly picks one file, loops it, Opus-encodes it, and sends it as normal voice traffic.
166
+
167
+
If the folder does not exist, Basis creates it. If the folder exists but contains no audio files, the headless client stays silent.
168
+
169
+
Non-48 kHz files are resampled automatically to mono `48 kHz`.
170
+
171
+
### Where to put the files
172
+
173
+
For a normal extracted build, place files in the headless data folder under:
174
+
175
+
- `AudioClips/`
176
+
177
+
For Docker, mount a folder into the player's data directory `AudioClips` folder.
0 commit comments