<!-- TITLE: Beginners Guide --> <!-- SUBTITLE: Getting Started --> # How to install mods ## Preface Beat Saber was not designed with mod support, so it needs to be patched to enable mods. >By choosing to use mods, you understand that: > - You may experience problems that don't exist in the vanilla game. 99.9% of bugs, crashes, and lag are due to mods. > - Mods are subject to being broken by updates and that's normal - be patient and respectful when this happens, as modders are volunteers with real lives. > - Beat Games aren't purposefully trying to break mods. They wish to work on the codebase and sometimes this breaks mods, but they are not out to kill mods. > > Do not attack the devs for issues related to mods, and vice versa - modders and devs are two separate groups. Just don't be a jerk ok {.is-danger} Every time the game updates, you will have to do this process again to get all compatible mods. Since mods are made by volunteers, you may need to wait for your favorite mod to be fixed for the latest game version. Make sure to check the #server-announcements channel in the discord for the latest updates! If you run into problems at any point, please head to the [support page](support#1-4-no-mods-in-game) and see if you can identify what went wrong before asking in the discord server. Chances are, your answer is on that page! ## Installers The mod repository ModSaber has shut down, and lolPants has left a [message](https://www.modsaber.org/) on the site explaining the situation. > If you're updating the game from 0.12 to 0.13, you'll likely need to do a clean install if you own the game on the Oculus Home store, or verify your files if you own the game on Steam. The process is described more in the [support page](support#2-2-black-screen-environment-unity-crash-window-game-wont-start-at-all). {.is-warning} ### Mod Assistant **Run the game at least once** before trying to mod the game! This applies to reinstalling your game too. A simple Beat Saber Mod Installer similar to the mod manager, but with additional features such as mod removal and version checking! Get it on [Assistant's GitHub](https://github.com/Assistant/ModAssistant/releases/latest) ![Modassistant](/uploads/modassistant.png "Modassistant") ### BeatDrop **Run the game at least once** before trying to mod the game! This applies to reinstalling your game too. BeatDrop 2 is an iTunes / Spotify-like song manager, downloader, playlist creator and mod installer / manager for Beat Saber, all rolled up into a single beautiful and easy to use app. [Get it over on StarGazer's GitHub!](https://github.com/StarGazer1258/BeatDrop/releases). Here's a [short tutorial](https://www.notion.so/BeatDrop-2-Tutorial-e6a98d87b14a4621bd0941c5f8953be9) that explains how it works. ![Beatdrop 800](/uploads/beatdrop-800.jpg "Beatdrop 800") Note that BeatDrop is still in development and currently lacks mod updating functionality, but it's highly recommended for song and playlist management. Stay tuned for the addition of more features! To update mods, simply uninstall the mod and redownload it to get the latest version, or use an alternative method to update your mods. ### Beat Saber Mod Manager > Note: BSMM is getting increasingly difficult to maintain and has several underlying problems that have never been fixed. It does not support dependencies (a mod relying on another mod) nor does it support uninstalling. It will be deprecated in the future, so consider switching to one of the above installers. **Run the game at least once** before trying to mod the game! This applies to reinstalling your game too. The Beat Saber Mod Manager has been revived and modified to use our new mods repository, [BeatMods](https://beatmods.com/)! Simply check off the mods you want to be installed, and they'll be downloaded to `IPA/Pending` until you launch the game. Created by Umbranox and Megalon, and available via the [BSMG GitHub!](https://github.com/beat-saber-modding-group/BeatSaberModInstaller/releases/latest) ![Bsmm](/uploads/bsmm.png "Bsmm") If there are any permission errors, try running the application in admin mode. # How to get more songs The `Song Loader Plugin` enables you to load more songs into the game, but only includes one test song. ## Ingame Downloader The `BeatSaver Downloader` Plugin allows you to download maps in-game using the `MORE SONGS` menu button on the main menu screen. This pulls maps directly from www.beatsaver.com ## Beat Saver [Beat Saver](https://www.beatsaver.com) is the central repository that holds nearly all custom songs/maps for Beat Saber. You can manually place the zip files downloaded from Beat Saver into the `CustomSongs` folder in your Beat Saber directory, use the In-Game Downloader Plugin, or use the OneClick Install button, which is compatible with all 3 installers listed above. There are a couple more resources to help you find songs over in the [FAQ](faq#more-songs) # How to uninstall mods **Currently the only way to uninstall a mod is to remove the dll from the `Plugins` folder.** | | | | --- | --- | | Steam | `\steamapps\common\Beat Saber\Plugins` | | Oculus | `\hyperbolic-magnetism-beat-saber\Plugins` | # Manual Installation Only resort to this if you absolutely know what you're doing, the installer is the recommended way to install mods. **Run the game at least once** before trying to mod the game! This applies to reinstalling your game too. 1. Download [BSIPA](https://github.com/nike4613/BeatSaber-IPA-Reloaded/releases/latest/download/BSIPA.zip). 2. Navigate to your [install folder.](faq/install-folder) and extract the contents of BSPIA into it. ![Directory Clean](/uploads/directory-clean.png "Directory Clean") ![Directory Ipa](/uploads/directory-ipa.png "Directory Ipa") 3. Double click IPA.exe to patch the game. Any mods in the `Plugins` folder will now be loaded when starting the game. If there are errors, you probably didn't follow step 2 correctly. ![Directory Patched](/uploads/directory-patched.png "Directory Patched") 4. Download the mod(s) you wish to install, whether it be from GitHub, the #finished-mods channel, or other sources. **Make sure to download any dependencies required by the mod.** ![Directory Plugins](/uploads/directory-plugins.png "Directory Plugins") 5. Some mods have installation instructions, some don't. Generally you can just drag and drop the zip contents into your beat saber install folder, and the files should go into the corresponding folders. # Where to go from here * [Grips and tricks](grips-and-tricks) * [Making beatmaps](mapping) * [Custom sabers](models/custom-sabers) * [Custom avatars](models/custom-avatars) * [Custom platforms](models/custom-platforms) * [Setup multiplayer](https://bs.assistant.moe/Multiplayer/) * [Making mods](modding) # Have questions? Visit the [FAQ](faq) or drop by the #support tab in the [discord](https://discord.gg/beatsabermods)!