Skip to content
Zingabopp edited this page Mar 16, 2022 · 12 revisions

Beat Saber Modding Tools

A set of tools and templates for creating Beat Saber mods.

Visual Studio Extension

Requires Visual Studio 2019 or 2022, installation instructions can be found here. It contains the following:

  • The ability to set your Beat Saber directory in the extension and automatically or manually generate a csproj.user file for Beat Saber projects (detected by checking for an IPA.Loader reference).
  • A Reference Manager for easily adding Beat Saber references to the project using the BeatSaberDir project property for the HintPath.
  • Project Templates
    • BSIPA Plugin (Core): A basic mod template with a MonoBehaviour controller and optional BSIPA config support.
    • BSIPA Plugin (Bare): Pretty much the bare minimum to have a working mod.
    • BSIPA Plugin (Disableable): A template for a mod that can be enabled/disabled while the game is running. Not recommended for new modders.
  • Item Templates
    • MonoBehaviour Template: Creates a new MonoBehaviour class with commonly used messages.
    • BSML File Template: Creates an empty BSML file with the schema defined.
    • BSML ViewController Template: Creates a new BSMLResourceViewController with a dependent .bsml file.

Getting Started

  1. Installation instructions Here
  2. Read the getting started guide Here