EnhancedTwitchChat is a rich text Twitch chat integration mod with full unicode, emote, cheermote, and emoji support.
- Full Rich Text Support, see ALL of your Twitch chat when immersed in Beat Saber!
- This includes all Twitch badges, emotes, cheermotes, BetterTwitchTV emotes, FrankerFaceZ emotes, all Emojis and even animated emotes!
- This also includes full Unicode Support! This means you can enjoy the chat in any language!
- Song Requests!
- Automatically queue/process song requests directly from your Twitch chat!
- Use commands !bsr, !request, or !add (by default) to request songs by name or BeatSaver ID!
- These commands are fully customizable! See the config section below for more information!
- Customizable User Interface
- Change the scale, width, text/background colors, and chat order!
- Coming soon:tm:
- Popular alert API integration with services such as streamlabs
- More chat customization options!
Enhanced Twitch Chat depends on CustomUI, SongLoader, and AsyncTwitch. Make sure to install them, or Enhanced Twitch Chat won't work!
Copy EnhancedTwitchChat.dll to your Beat Saber\Plugins folder, and install all of its dependencies. That's it!
All you need to enter is the channel name which you want to join (see the Setup section below), the chat will show up to your right in game, and you can move it by pointing at it with the laser from your controller and grabbing it with the trigger. You can also move the chat towards you and away from you by pressing up and down on the analog stick or trackpad on your controller. Finally, you can use the lock button in the corner of the chat to lock the chat position in place so you don't accidentally move it.
Most common options can be configured directly via the Beat Saber settings menu in the Enhanced Twitch Chat submenu, as seen in the image below. Keep in mind that in order for song requests to appear in chat, you need to enter your TwitchUsername and TwitchOAuthToken in EnhancedTwitchChat.ini! If you do not do this, only YOU will see the song requests being accepted in the Enhanced Twitch Chat display! For more information, see the Config section below.
For the rest of the config options, you will have to manually edit the config file (in UserData\EnhancedTwitchChat.ini). Keep in mind all config options will update in realtime when you save the file! This means you don't have to restart the game to see your changes! Use the table below as a guide for setting these values (NOTE: The only required config option is TwitchChannelName):
| Option | Description |
|---|---|
| TwitchChannelName | The name of the Twitch channel whos chat you want to join (this is your Twitch username if you want to join your own channel) |
| TwitchUsername | Your twitch username for the account you want to send messages as in chat (only matters if you're using the request bot) |
| TwitchOAuthToken | The oauth token corresponding to the TwitchUsername entered above (Click here to generate an oauth token) |
| FontName | The name of the system font that should be used for chat messages. You can specify any font installed on your computer! |
| ChatScale | How large the chat messages/emotes should be displayed. |
| ChatWidth | The width of the chat, regardless of ChatScale. |
| LineSpacing | Determines the amount of extra spacing between lines of chat |
| MaxChatLines | The maximum number of lines allowed in chat at once. |
| PositionX/Y/Z | The location of the chat in game (this can be adjusted in game, see description above!) |
| RotationX/Y/Z | The rotation of the chat in game (this can be adjusted in game, see description above!) |
| TextColorR/G/B/A | The color of chat messages, on a scale of 0-1. If your colors are between 0-255, just divide by 255 to get this value! |
| BackgroundColorR/G/B/A | The color of the chat background, on a scale of 0-1. If your colors are between 0-255, just divide by 255 to get this value! |
| BackgroundPadding | Determines how much empty space there will be around the borders of the chat. |
| LockChatPosition | Whether or not the chat can be moved by pointing at it with the controller laser and gripping with the trigger. |
| ReverseChatOrder | When set to true, chat messages will enter from the top and exit on bottom instead of entering on bottom and exiting on top. |
| AnimatedEmotes | When set to false, animated emotes/cheermotes will not move at all. |
| DrawShadows | When set to true, shadows will be drawn behind emotes/text (looks nicer in windowed view, not really noticeable in headset). |
| SongRequestBot | When set to true, users can make song requests in chat. |
| RequestCommandAliases | The name(s) of the chat command(s) that you want to use for song requests. |
| RequestLimit | The maximum number of requests a user can make within the amount of time defined in RequestCooldownMinutes. |
| RequestCooldownMinutes | A user can make as many requests as are defined in RequestLimit within this amount of time. |
| SongBlacklist | A list of BeatSaver ids that are not allowed to be requested. |
To compile this mod simply clone the repo and update the project references to reference the corresponding assemblies in the Beat Saber\Beat Saber_Data\Managed folder, then compile. You may need to remove the post build event if your Beat Saber directory isn't at the same location as mine.