Skip to content

Commit

Permalink
fix(docs): minor fixes in query string page
Browse files Browse the repository at this point in the history
  • Loading branch information
timotheeg authored Jul 28, 2024
1 parent aaf1534 commit 58557a0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/query_string_args.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Caveat: global args apply to **MOST** layouts, but some layouts
| `tetris_flash` | `0`: NO Flash<br>`1`: Classic flash<br>`2`: Fade Flash<br>`3`: Swipe Flash<br>`4`: Explode Flash | `2` | Classic Flash may cause discomfort for viewers with light sensitivity |
| `avatar` | `0`: NO avatar underneath the playfield<br>`1`: Show avatars underneath the playfield | `1` | Avatar images are taken from Twitch<br>Avatar images can be overridden to custom images in the admin page |
| `video` | `0`: DON'T display player video<br>`1`: Play player video | `1` | Even if video is not set to zero, video only show if users agree to share their video in their producer page |
| `buffer_time` | An integer value representing the number of milliseconds for frames to be buffered before they are rendered. E.g. `500` | `0` (i.e. buffer is not used) | A buffer can be useful if the network is not very stable and rendering is choppy. Noe that putting in a large value for `buffer_time` can cause the game play to be perceivably delayed compared to the player video feed, and look "weird" (player reacts before the thing they were doing happens!). |
| `buffer_time` | An integer value representing the number of milliseconds for frames to be buffered before they are rendered. E.g. `500` | `0` (i.e. buffer is not used) | A buffer can be useful if the network is not very stable and rendering is choppy. Note that putting in a large value for `buffer_time` can cause the gameplay to be perceivably delayed compared to the player video feed, and look "weird" (player reacts before the thing they were doing happens!). |
| `combot` | `0`: No commentary bot<br>`1`: Activate commentary bot | `0` | Commentary bot uses the browser [Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) to give score updates for the first match in an NTC room (between player 1 and 2)|
| `lang` | `en`: Commentary bot in English<br>`fr`: Commentary bot in French | `en` | This argument controls the `combot` (see above)|

Expand Down

0 comments on commit 58557a0

Please sign in to comment.