Ultimate Guide to Beat Saber Plugins

BEAT SABER TIPS

INTRODUCTION TO PLUGINS

BEGINNERS GUIDE TO MODDING BEAT SABER

 

Modding intro image

 

What are plugins?

Plugins are software components that users (like you) install separately into a game directory to customize it with features not available in its original state.

 

 

Who are the modders?

Modders are the community members who built the plugins / mods you’re using. They are not the game developers, they are mod developers.

 

 

-IMPORTANT UPDATE-

10 June 2019 – Beat Saber patch v1.1.0 is out. On the modding side, we’re moving to a new file format for custom maps and everything that relies on it. This is to match the Custom Levels update from the full release v1.0.0. Please be patient while everything is set up and features are being added/improved.

Now we have two new mod managers that grab plugins from the mod repository – BeatMods

  1. Mod Assistant
    Lightweight version of mods installer/manager
  2. Beatdrop
    Elaborate version of mods and songs installer/manager (Disclaimer: may not work properly for a long while until StarGazer finishes updating it)

Pick just one you prefer and enjoy!

 

INSTALL MODS MANUALLY?

If you have either of the above mod managers, you don’t need to do everything manually.

A concise, in-depth manual installation guide for the latest update will be included when available. But basically run the game once, grab BSIPA from beatmods and run it inside the game folder, and then grab the Mods with Core and Libraries tags.

 

 

[ IMPORTANT NOTE ]

If you mod your game, there is a chance that it will break right after an update. Give it some time and refer to tips provided below:

Any issue you encounter with a modded game should not be directed to Beat Games. Reach out to Beat Saber Modding Group (BSMG) in their #support channel for assistance & troubleshooting. Remember to adhere to the rules.

 

The people who made all these awesome stuff can often be found in the BSMG Discord server. When you see them, feel free to give some constructive feedback or just simply say thanks for spending their precious time to work on the mods. That will make their day.

 

The community may assist wherever possible, but ultimately you are the one responsible for your gaming experience. READ Mod Info / Description in your mod manager or [More Info] before attempting a Download. “Do not bite off more than you can chew.”

 

 

TL;DR

The list of available plugins updates frequently. Today you may see things looking slightly different than in this guide. Tomorrow they might take on a different name or even become irrelevant. That is why guides like this are either hard to find or outdated. I will update this guide as often as I can until there is a ‘fix’, but for now here’s a quick tips as easy as 1, 2, 3 :

 

  1. When in doubt, re-run your mod manager (Refer next section)
  2. If that doesn’t work, reinstall the game, run the game once and close it, and then do Step 1 (remember to backup your custom songs etc before uninstalling)
  3. If issue still persists, find the modding experts in Beat Saber Modding Group (BSMG) Discord server

 

GETTING STARTED

For a quick guide on how to start modding – Mod Install Guide 

 

BeatDrop

 

BeatDrop 2.2.0

 

 

Mod Assistant  

 

Mod Assistant v1.0.13.png

 

BeatDrop and Mod Assistant are two different applications that serve the same purpose – to install your mods. BeatDrop currently has more features such as Download maps and create Playlists. They are almost a necessity when performing modifications to Beat Saber – especially for beginners. Each of them serve as your go-to one click application that hosts plugins from the repository, and will help Install or Update your plugins into the Plugins folder. You need only ONE of them so choose whichever that suits your taste.

 

Option 1

To install BeatDrop, go to https://bsaber.com/beatdrop/ and click on the [GET BEATDROP 2 NOW] button. Next, save the application somewhere easily accessible on your computer and then double click to open.

 

Option 2

To install Mod Assistant, go to https://github.com/Assistant/ModAssistant/releases/latest and click on the [ModAssistant.exe] link. Next, save the application somewhere easily accessible on your computer and then double click to open.

Remember to read the instructions/disclaimers etc because they are important, and then proceed to click the agreement button. Next, make sure the folder path in Options tab is pointing to your game folder and then choose the plugins you want in the Mods tab. It is not advisable that you install every mod since it will get overwhelming. Read the Mod Info and tick the ones you want to try out. You can always come back and add more.

 

So now that you have one of the installers open, the rest is simple.

  1. Make sure the game Installation Directory / Folder Path matches where your game is installed (check in Settings/Options tab)
  2. Read Mod Info of the plugins you’re interested in
  3. Understand the instructions/information written
  4. Select the plugin(s) in your mod manager
  5. Click the “Install / Update” button and run the game

 

Advanced users: The latest version of plugins you have are sometimes sitting in a queue awaiting approval for quality control purposes. They go through a strict process of testing before being released to us – users. If you really can’t wait, you can look up their respective github pages, if any, or download from the #finished-mods channel in BSMG Discord server.

 

PLUGIN DETAILS

 

 

Core Plugins

Song Core

Converts your custom songs files to the new format and improves their initial loading time significantly especially for players with a huge amount of custom maps. It also handles map requirements, custom song colours, custom song platforms, and many more. Some plugins rely on its custom songs library management feature.

 

BSIPA

This is perhaps the center of the core of every mod, since it actually loads your plugins along with the rest of its useful features.

 

 

Score Saber

This is an independent plugin that stores all your best scores with or without modifiers upon completing custom songs into the scoresaber website. Installing this plugin allows you to compare scores with your friends and other players in the global leaderboard. If you don’t have this installed, score submission will be limited to only  your Original Soundtrack (OST) songs while your custom songs scores will be recorded locally (in your computer). There is a “Replay” function where it saves your saber movement in Ranked maps if your score is within top 250.

Website : https://scoresaber.com

Scoresaber

 

 

BeatSaver Downloader

Download custom songs in game without having to take your VR headset / HMD off.

BeatSaver DownloaderBeatSaver Downloader2

 

 

Camera Plus

A less shaky version of the mirrored Beat Saber window from your HMD. If you’re setting up for a demo or if you are streaming your gameplay, this is your alternative to the built in Camera Smoothing feature in base game. There is an option to capture your gameplay or avatar in third person view.

 

BSIPA Mod List

An update manager in game. Once it runs an update on a mod, you may need to restart the game for it to take effect.

Song Browser

Additional sorting and searching options among other useful features. Find latest instructions in Mod Info.

SongBrowser

 

 

 

Cosmetic Changes

Custom Sabers

Once you install the plugin and run the game, a CustomSabers folder will be created. This is where your favourite custom models from https://modelsaber.com/ are placed.

You can manually Download the models or directly Install them. Directly installing means you don’t need to manually drag the downloaded custom model into the CustomSabers folder. To perform the “Install” method successfully, you will need to enable OneClick Installs in Mod Assistant.

CustomSabers

 

 

Custom Avatars

Once you installed the plugin and run the game, a CustomAvatars folder will be created. This is where your favourite custom models from https://modelsaber.com/ are placed.

You can manually Download the models or directly Install them. Directly installing means you don’t need to manually drag the downloaded custom model into the CustomSabers folder. To perform the “Install” method successfully, you will need to enable OneClick Installs in Mod Assistant.

Press Home key to toggle show/hide your avatar in HMD & press PgUp / PgDn to scroll through your avatar list. Find latest instructions in Mod Info.

CustomAvatar

 

 

Custom Platforms

Once you installed the plugin and run the game, a CustomPlatforms folder will be created. This is where your favourite custom models from https://modelsaber.com/ are placed.

You can manually Download the models or directly Install them. Directly installing means you don’t need to manually drag the downloaded custom model into the CustomSabers folder. To perform the “Install” method successfully, you will need to enable OneClick Installs in Mod Assistant.

 

Custom Colors

Allows you to customize the colors in Beat Saber. Find latest instructions in Mod Info.

 

 

Gameplay

Darth Maul

Reference to Star Wars. If you know one, you will recognize the other. Find latest instructions in Mod Info.

 

Gameplay Modifiers Plus

“Massive pile of stuff. 1/4 of the plugin is for streamers, 1/6 or so quality of life stuff, and about 14/24 options for ways to make gaem funner” – Kyle 1413

Find latest instructions in Mod Info.

 

Gameplay Restrictions Plus

A stricter gameplay system that you set yourself.

Find latest instructions in Mod Info.

 

Hidden Blocks

If you are familiar with how the Disappearing Arrows modifier looks like in the game, this one takes it one step further – the blocks disappear. Find latest instructions in Mod Info.

 

Beat Saber Challenges

This mod adds challenges to the game where you must play with certain modifiers, fulfill certain requirements, or both for a given map. Currently there are Custom Campaigns and Daily Challenges. Find latest instructions in Mod Info.

 

 

Libraries

The ones you see under Libraries category are tied to certain plugins because of dependencies. They are there to make certain mods work and do nothing on their own. You don’t have to worry about downloading these if you have either BeatDrop or Mod Manager installed, since they should auto-select them if necessary for the plugins you were getting.

 

Stream Core

Ini Parser

MappingExtensions

BS Utils

CustomUI

Harmony

 

 

 

Practice / Training

CountersPlus

A mod that feed you live information on parameters of your gameplay that you enable as you play through a song. Find latest instructions in Mod Info.

 

Hit Score Visualizer

Colors the score popups that appear after hitting notes. Also adds judgement text above (or below) the score. Find latest instructions in Mod Info.

 

Intro Skip

Allows you to skip intros and outros of songs with no significant events that affect scoring. Find latest instructions in Mod Info.

 

Leaderboard In Song

A leaderboard display of the current map/song you’re challenging, visible after clicking the PLAY button.

 

Practice Plugin

Control playback speed, seek through songs, set up looping sections and more. Find latest instructions in Mod Info.

 

 

Stream Tools

This category is for people who stream their gameplay or run a demo with attention to detail.

Enhanced Twitch Chat

Adds a chat window of your Twitch channel in game and allows your viewers to request songs by typing certain commands. Also useful for other players & spectators in your gaming session to follow the conversation. Song requests require TwitchOAuthToken so only the streamer has the ability to moderate it. Find latest instructions in Mod Info.

Formatting example in game folder > UserData > EnhancedTwitchChat.ini:
TwitchChannelName=”ag0za”
TwitchUsername=”ag0za”
TwitchOAuthToken=”oauth:xxxxxxxxxxxx”
FontName=”Segoe UI”
……………….(cont)…………………

 

 

HTTP Status

Enables the building of custom stream overlays that displays the song name and player’s performance in real time. There are other potential use cases for modders but stream overlay is what most of us will use this for. Find latest instructions in Mod Info.

 

Tweaks / Tools

Beat Saber Tweaks

Extra settings options to tweak some variables that you never knew you needed. Find latest instructions in Mod Info.

 

Custom Menu Music

Changes the music in the menu. Find latest instructions in Mod Info.

 

 

UI Enhancements

Beat Singer

Display floating lyrics while progressing a song in game.

 

 

Notes Left Counter

Shows you how many notes are left in the song as you progress. Find latest instructions in Mod Info.

 

 

Lighting Changes

ChromaLite

Enables special colours in maps lighting as well as some other special events for Mappers. You may see a message or indicator stating that it conflicts with another Lighting mod like Rainbow Lighting and this means they cannot coexist. Find latest instructions in Mod Info.

 

Rainbow Lighting

Randomizes the background lighting in songs for a more colorful experience. You may see a message or indicator stating that it conflicts with another Lighting mod like ChromaLite and this means they cannot coexist. Find latest instructions in Mod Info.

 

 

Multiplayer

Unofficial Multiplayer

Play against other players in real time. Find latest instructions in Mod Info.

 

Other

Discord Presence

A Discord rich presence plugin to tell your friends what you are up to in the game, in real time.

 

Archived/WIP (as of editing)

Full Combo Display

Display a ring around your combo multiplier if you haven’t missed a block. Find latest instructions in Mod Info.

 

Perfection Display

Displays how many in a range of scores per block you’ve hit or missed to the results screen. Find latest instructions in Mod Info.

 

BloomMod

Customize internal bloom effect parameters of each cameras in-game. Find latest instructions in Mod Info.

 

SyncSaber

Keeps your songs up to date, optionally downloads the newest releases from your favorite mappers, as well as content from your bookmarks on BeastSaber. Find latest instructions in Mod Info.

 

YUR Fit Calorie Tracker

Counts your active calories while playing Beat Saber. Find latest instructions in Mod Info.

 

Custom Fail Text

Changes the text when you fail a song. Find latest instructions in Mod Info.

 

Custom Menu Text

Customizes the “BEAT SABER” menu text to different wording. Find latest instructions in Mod Info.

 

Custom Miss Text

Changes the text that appears when you miss a note. Find latest instructions in Mod Info.

 

Particle Overdrive

Controls the nature and amount of particles to be displayed, generally related to PC performance. Find latest instructions in Mod Info.

 

In Game Song Library Refresher

Very simple plugin that adds a button in game to refresh your song library.

 

Song Status

Writes currently playing song status to a text file that can be read by programs like OBS. This behaves similar to HTTP Status stream overlay in functionality but they use different approach. Find latest instructions in Mod Info.

 

Song Loader Plugin

If you’re here to get custom songs, the Song Loader plugin is what you need. It is already pre-selected in both installers, along with BSIPA so you can simply read the Mod Info and just click the “Install / Update” button. This will create a CustomSongs folder in your game directory along with some additional files that will enable the game to run custom songs.

 

 

Here is another guide with additional info; https://bsaber.com/installing-the-mod-guide-necessary-for-any-custom-songs/

SongloaderSongloader2

 

 

Comments (4)
  1. Funky says:

    Just delete all the outdated information! I am new to the game and you have made things ten times more difficult with all the conflicting information in here. I still haven’t got ANY mods to work. This page is useless

    (4)
    1. Agoza says:

      Hi! Thanks for the reminder. Everything was kept so the crossed out parts can simply be replaced when we have 100% migrated from modsaber. I am currently working on something else in real life and my Rift headset is still under RMA, so please understand that it will take some time as this is a pretty long guide. I’ll push an update pretty soon. For now please refer to this guide by elliottate – https://bsaber.com/installing-the-mod-guide-necessary-for-any-custom-songs/

      (0)
  2. Alek Shkarynsky says:

    how do I contact the moders

    (0)
    1. Agoza says:

      Hi, most of them can be found on the modding group Discord – https://discord.gg/beatsabermods

      (0)

Leave a Reply

Your email address will not be published. Required fields are marked *