Repository files navigation

Discord Rich Presence support for Beat Saber, now with 100% more configurability!

Displays information about the current song (including ranked status), modifiers (as emojis), play/pause state, multi/singleplayer, current score, combo and accuracy by default. Time left is also displayed while playing (speed modifiers are also accounted for).

^{Credits: Profile picture bybrizunzies, banner byZell}

While the mod has a few basic configuration options exposed on the UI via the Mod Settings menu, currently most config options can be edited via the JSON file primarily, as I have no idea how to create an interface for some of these options. If you happen to be well-versed in creating in-game configuration UIs any help would be greatly appreciated.

Can be used to provide a customDiscord App ID in case you want to define your own image files, or change the first line of the Rich Presence, as that's controlled by the App's name.

The default is an App ID created by the mod's author that works with the default configuration of the mod.

If you want to create your own App, you will need to upload image assets with specific names to match the ones defined in the mod. See theRichPresenceResources.cs file for exact names.

Whentrue the mod will detect when you are in the built-in Multiplayer menu. It will also change the "lobby type" displayed in later steps.

Whentrue andMultiplayerDetection is also enabled, the mod will display the size of the lobby as well as the number of people in it inside the rich presence.

Whentrue the mod sets the song cover image as the large image, if it's available. It only works for songs available on BeatSaver, and can be set tofalse to show the image of the current envorment instead, which is also used as a fallback in case no cover art is available.

Whentrue the amount of time spent in the Main Menu or Multiplayer Lobby is displayed. The timer resets after starting a map or going in and out of a lobby.

Whentrue the map type (standard, one-saber, 360, etc.) will be displayed as the small image for the rich presence. TheSmallTextFormat tooltip configured later will not be readable if this is set tofalse.

Whentrue the "end time" for the rich presence activity is calculated and set dynamically based on the current song speed modifiers while actively playing a map. When set tofalse, only the "start time" will ever be set.

Whenfalse the activity start time is set to (roughly) when the game was opened and will not change when switching between menus and playing a map. Useful if you want to show your total playtime instead of time spent in a level for example.

This can be used to change the text displayed when using themapType variable. Set the value to the text you want to see displayed, or an empty string to prevent that value from being displayed.Fallback can be set if you want a specific text to be displayed in case the map type being reported by the DataPuller mod does not have a readable name mapping. By default this isnull and it will display the value sent by DataPuller.

There are several options which accept "format lists":

• DetailsFormat - the 2nd line of the rich presence (below the app name) while playing a song
• StateFormat - the 3rd line of the rich presence while playing a song
• LargeTextFormat - tooltip displayed when hovering over the large image
• SmallTextFormat - tooltip displayed when hovering over the small image

Each string in the list will only be appended to the final output in case it has a "valid" value (valid is subjective and it is defined by the mod). Each value in the list takes the form of"prefix{{variable}}suffix" whereprefix andsuffix can be an arbitrary number of characters before and after the variable, respectively, andvariable is the name of the variable from the table below.

The strings also have configurable separators that go between each valid item. By default this is a space forDetailsFormat andStateFormat, and a slash surrounded by spaces (/) forLargeTextFormat andSmallTextFormat. You can also disable displaying the individual lines by setting them tonull instead of the list.

This can be used to change the text displayed when using thefullCombo variable. Set the value to the text you want to see displayed, or an empty string to prevent that value from being displayed.

This controls the 2nd line of the rich presence while in the main menu. Set the value to the text you want to see displayed, or an empty string to prevent that value from being displayed.

This controls the 2nd line of the rich presence while in a multiplayer lobby. Set the value to the text you want to see displayed, or an empty string to prevent that value from being displayed.

ThePlayStateEmoji,ModifierEmoji andLobbyTypeEmoji options allow you to remap the emoji displayed in theplayState,modifiersState andlobbyType variables. Set the value to the emoji (or any arbitrary text) you want to see displayed, or an empty string to prevent that value from being displayed.

• BSIPA v4.3.3 (ModAssistant)
• BeatSaberMarkupLanguage v1.12.1 (ModAssistant)
• DiscordCore v3.0.6 (https://github.com/DJDavid98/DiscordCore/releases/tag/v3.0.6)
• DataPuller v2.1.14 (https://github.com/DJDavid98/BSDataPuller/releases/tag/2.1.14)