Skip to content

[EN] Chat Request

HardCPP edited this page Jan 27, 2021 · 12 revisions

The Chat Request module enables viewers to request maps to the streamer directly in their Twitch chat. When a request is carried out, it is added to the request queue. The streamer only has to open the waiting queue and click on the song to download it and play the map.

1 - Interface

2 - General settings

User max request

The maximum number of requests a viewer can carry simultaneously.

VIP bonus request

The number of additional requests channel VIPs can carry (cumulative with Subscriber bonus request).

Subscriber bonus request

The number of additional requests channel subscribers can carry (cumulative with VIP bonus request).

History size

Request history size (i.e., save the last [x] maps requested).

Play preview music if downloaded

Self-explanatory.

Give moderators power to manage queue

Self-explanatory.

Queue command show count

The number of songs displayed when the « !queue » command is executed.

Queue command cooldown seconds

Cooldown (in seconds) before re-enabling the « !queue » command.

3 - Filter settings

NJS min

The minimum NJS (Note Jump Speed) that a map must have to be added to the queue. Searches in every game mode and every difficulty to figure out if at least one has a greater NJS than the minimum required.

NJS max

The maximum NJS (Note Jump Speed) that a map must have to be added to the queue. Searches in every game mode and every difficulty to figure out if at least one has a lower NJS than the maximum required.

⚠️ In case NJS and NJS max are activated simultaneously, the map must meet both requirements.

NPS min

The minimum NPS (Note Per Second) that a map must have to be added to the queue. Searches in every game mode and every difficulty to figure out if at least one has a greater NPS than the minimum required.

NPS max

The maximum NPS (Note Per Second) that a map must have to be added to the queue. Searches in every game mode and every difficulty to figure out if at least one has a lower NPS than the maximum required.

⚠️ In case NPS and NPS max are activated simultaneously, the map must meet both requirements.

Duration max

Only maps that don’t exceed this duration can be added to the queue.

Vote min

Minimum upvote/downvote ratio a map must meet to be added to the queue.

Upload date min

Minimum upload date of a map so that it can be added to the queue (i.e., maps uploaded earlier cannot be queued)

Upload date max

Maximum upload date of a map so that it can be added to the queue (i.e., maps uploaded later cannot be queued)

4 - Chat commands

!bsr

Requests a map (by adding the map code or map name). Example: !bsr ff9 Example: !bsr Smooth Criminal

!bsrhelp

Displays a quick tutorial on “How to request a map?”.

!oops !wrongsong !wrong

Cancels the last request.

!queue

Displays non-played requests list with total duration.

!queuestatus

Indicates if the queue is opened or closed (thus, if viewers can request or not), reamainig song count, and queue total duration.

!link

Displays the current map’s name and mapper’s name. The bot also looks for the map on BeatSaver. If the map is available, a link to it will be displayed to access it.

!modadd

Moderators only. Requests a map, ignoring filters and blacklist.

!att

Moderators only. Requests a map directly on top of the queue.

!mtt

Moderators only. Moves a request on top of the queue (only works with map code).

!block

Moderators only. Blacklists a map in the queue (only works with map code).

!remove

Moderators only. Removes a map from the queue (only works with map code).

!open

Moderators only. Opens queue (enables requests).

!close

Moderators only. Closes queue (disables requests).

5 - Database file

6 - OBS integration

Clone this wiki locally