/CustomPlatforms

A BSIPA Plugin for Beat Saber that adds support for custom environments (platforms)

Primary LanguageC#GNU General Public License v3.0GPL-3.0

Installation

Easy Method

Manual Method

  • Ensure your game is patched with IPA (The mod installer does this for you)
  • Extract CustomPlatformsX.Y.zip (Not the Unity Project zip!) into your Beat Saber directory
  • Add .plat files to the "CustomPlatforms" directory - A few are included

Your Beat Saber folder should then look like this:

| Beat Saber
  | Plugins
    | CustomPlatforms.dll     <-- 
  | CustomPlatforms		<--
    | <.plat files>		<--
  | IPA
  | Beat Saber.exe
  | (other files and folders)

Controls

Visit the ModSettings page ingame to access important settings, like:

  • Always show feet, to mark the center of the room,
  • Hide the ❤️ that CustomPlatforms uses as a cloneable light source
  • etc.

You can press Numpad0 (while playing songs) to toggle the heart on and have it react to light events.

Adding More Platforms

Place platforms (.plat) files in the "BeatSaber\CustomPlatforms" folder. Your installed platforms will be available upon relaunching the game.

Creating New Platforms

There's a comprehensive guide at https://bs.assistant.moe/Platforms/ written by Emma. The following are the basic steps:

  1. Download the Unity project from the releases page, unzip it.

  2. Open the Unity project The project was created and tested in version 2018.1.6f1, other versions may not be supported.

  3. Create an empty GameObject and attach a "Custom Platform" component to it Fill out the fields for your name and the name of the platform. You can also toggle the visibility of default environment parts if you need to make room for your platform. Add an icon for your platform by importing an image, settings it to Sprite/UI in import settings, and dragging it into the icon field of your CustomPlatform

  4. Create your custom platform as a child of this root object You can use most of the built in Unity components, custom shaders and materials, custom meshes, animators, etc. You cannot attach your own custom scripts to these objects. Only scripts from the CustomPlatforms dll will work.

  5. When you are finished, select the root object you attached the "Custom Platform" component to. In the inspector, click "Export". Navigate to your CustomPlatforms folder, and press save.

  6. Share your custom platform with other players by uploading the .plat file

Hall of Fame (Credits for major rework contributions)

AkaRaiden - (The QA Department, Beta Tester, Tome of Wisdom)

  • Without him this would have taken so much more time than it did.

Rolo - (The Master Mind, Inventor CustomPlatforms)

  • Went out of her way to help me clean up after six people messed with this.

Panics - (Chief Investigator)

  • Helped me get an initial grasp on the damage.

Tiruialon, Top-Cat

  • Thank you for your contributions!