Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/FizzyApple12/BeatSaberPresence

A mod for Beat Saber that adds Discord Rich Presence functionality.
https://github.com/FizzyApple12/BeatSaberPresence

Last synced: about 2 months ago
JSON representation

A mod for Beat Saber that adds Discord Rich Presence functionality.

Host: GitHub
URL: https://github.com/FizzyApple12/BeatSaberPresence
Owner: FizzyApple12
Created: 2020-10-23T08:25:45.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2022-06-29T06:57:22.000Z (about 2 years ago)
Last Synced: 2024-07-14T03:32:34.111Z (3 months ago)
Language: C#
Homepage:
Size: 56.6 KB
Stars: 56
Watchers: 7
Forks: 9
Open Issues: 6
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


    


        

        


        

    


    


    Beat Saber Presence

    


    


    




## What is this?

Beat Saber Presence is a fully customizable mod for Beat Saber which gives you Rich Presence functionality in Beat Saber.




## How can I customize it?

Inside of the game, on the mods panel, there is a tab for BeatSaberPresence. Inside that menu, you can:

* Enable or disable the rich presence

* Enable or disable the large Beat Saber cover art

* Enable or disable the small icon denoting what you are doing

* Enable or disable the timestamp which counts up

* Make the timestamp count down in game

Inside of the BeatSaberPresence.json (Beat Saber/UserData/BeatSaberPresence.json), you can customize:

* All previously mentioned properties

* The Rich Presence inside of the Menu:

  * The top and bottom lines underneath "Beat Saber" (``MenuTopLine`` and ``MenuBottomLine``)

  * The text shown when you hover over the Beat Saber cover art (``MenuLargeImageLine``)

  * The text shown when you hover over the small icon (``MenuSmallImageLine``)

* The Rich Presence inside of the Game:

  * The top and bottom lines underneath "Beat Saber" (``GameTopLine`` and ``GameBottomLine``)

  * The text shown when you hover over the Beat Saber cover art (``GameLargeImageLine``)

  * The text shown when you hover over the small icon (``GameSmallImageLine``)

* The Rich Presence when you are Paused:

  * The top and bottom lines underneath "Beat Saber" (``PauseTopLine`` and ``PauseBottomLine``)

  * The text shown when you hover over the Beat Saber cover art (``PauseLargeImageLine``)

  * The text shown when you hover over the small icon (``PauseSmallImageLine``)

When customizing the text, you can insert snippets which replace themselves with game data.

Snippet | Description | Replacement Example | Works In

--- | --- | --- | ---

``{DiscordName}`` | Replaced with your Discord username (no discriminator) | ``FizzyApple12 (She/Her)`` | Menu or Game

``{DiscordDiscriminator}`` | Replaced with your Discord discriminator (no username) | ``3494`` | Menu or Game

``{SongName}`` | Replaced with the name of the song you are playing | ``Killbot`` | Game

``{SongSubName}`` | Replaced with the subname of the song you are playing | ``Something or other`` | Game

``{SongAuthorName}`` | Replaced with the author of the song you are playing | ``Devin Martin`` | Game

``{SongDuration}`` | Replaced with the length of the song you are playing in minutes and seconds | ``03:32`` | Game

``{SongDurationSeconds}`` | Replaced with the length of the song you are playing in seconds | ``212`` | Game

``{LevelAuthorName}`` | Replaced with the name of the mapper of the song you are playing | ``JonathanRune`` | Game

``{SongBPM}`` | Replaced with the BPM of the song you are playing | ``120`` | Game

``{LevelID}`` | Replaced with the level ID of the song you are playing | ``custom_level_3DDE3B1...`` | Game

``{EnvironmentName}`` | Replaced with the name of the environment you are currently playing in | ``Nice`` | Game

``{Submission}`` | Replaced with ``Enabled`` or ``Disabled`` depending on the status of score submission | ``Enabled`` | Game

``{NoFail}`` | Replaced with ``On`` or ``Off`` depending on the status of the "No Fail" modifier | ``Off`` | Game

``{NoBombs}`` | Replaced with ``On`` or ``Off`` depending on the status of the "No Bombs" modifier | ``Off`` | Game

``{NoObsticles}`` | Replaced with ``On`` or ``Off`` depending on the status of the "No Obsticles" modifier | ``Off`` | Game

``{NoArrows}`` | Replaced with ``On`` or ``Off`` depending on the status of the "No Arrows" modifier | ``Off`` | Game

``{SlowerSong}`` | Replaced with ``On`` or ``Off`` depending on the status of the "Slower Song" modifier | ``Off`` | Game

``{InstaFail}`` | Replaced with ``On`` or ``Off`` depending on the status of the "Insta Fail" modifier | ``Off`` | Game

``{BatteryEnergy}`` | Replaced with ``On`` or ``Off`` depending on the status of the "Battery Energy" modifier | ``Off`` | Game

``{GhostNotes}`` | Replaced with ``On`` or ``Off`` depending on the status of the "Ghost Notes" modifier | ``Off`` | Game

``{DisappearingArrows}`` | Replaced with ``On`` or ``Off`` depending on the status of the "Disappearing Arrows" modifier | ``Off`` | Game

``{FasterSong}`` | Replaced with ``On`` or ``Off`` depending on the status of the "Faster Song" modifier | ``Off`` | Game




## What libraries or other plugins does it need?

This plugin is built using BSIPA4 so you need that, as well as

 * [SiraUtil](https://github.com/Auros/SiraUtil)

 * [BeatSaberMarkupLanguage](https://github.com/monkeymanboy/BeatSaberMarkupLanguage)

 * [DiscordCore](https://github.com/FizzyApple12/DiscordCore)




## Great! How do I get it?

You can either download a released version from the releases tab or build it yourself.

Here are the steps to build the Project:

1. Link all of the DLLs from the Beat Saber directory

2. Build the project

3. Copy ``BeatSaberPresence.dll`` to the ``Plugins`` folder

4. That's it! You're done!