Skip to content

Installation

Jump to bottom
BinaryElement edited this page Jun 11, 2019 · 8 revisions

Remind me to set up screenshot guides or something

Despite Chroma's size, installation is fairly simple. With that said, however, it's still not as easy as simply dropping a DLL file in your Plugins folder (especially in ChromaToggle's case).

Before you install anything, make sure you check the dependencies section in the FAQ and make sure you have all the dependencies you need!

Table Of Contents

All Chroma Suite Plugins

Typically, you should receive these plugins in a zip file. If you've just been provided the DLL, and this is your first installation, stop immediately, and find the latest relevant zip release and install it properly.

Place the zip file in the installation directory of Beat Saber, and unzip it in that location. If this is your first installation, it shouldn't ask to overwrite anything. If it does ask, you likely have some old Chroma files. Let it overwrite. The Chroma Suite does not overwrite any files other than what's already been provided by Chroma.

Done! That's it!

  • Key Things To Rememeber:
    • Install via a zip file, not just a DLL
    • Install everything from the zip file
    • DEPENDENCIES! Make sure you have them!

ChromaToggle

For a proper ChromaToggle installation, you need to also install Chroma. See the above guidelines (All Chroma Suite Plugins) and follow that advice for both Chroma and ChromaToggle.

  • Key Things To Remember:
    • Make sure you also install Chroma!
      • Make sure you have Chroma's dependencies too!
    • Install via a zip file, not just a DLL
    • Install everything from the zip file
      • ChromaToggle is less "foolproof" than Chroma, and messing up this step will cause errors

Installing Custom Gamemodes For ChromaToggle

If you just installed ChromaToggle, stop - before you do any more, test it! Make sure the built in gamemodes work before you try adding custom ones!

Custom Gamemodes are in the form of .xml files. You can get modes other players have made from the Chroma Discord, you can grab example gamemodes provided by ChromaToggle (including copies of the official gamemodes), or you can edit and create your own!

Once you have one of these XML files, installation is simple! Go to your Beat Saber installation folder, and navigate to Userdata/Chroma/CustomGamemodes and place the XML file in this folder.

Done!

  • Key Things To Remember:
    • You can find the example modes in Userdata/Chroma/ExampleGamemodes
    • You can find copies of the official gamemodes in Userdata/Chroma/OfficialGamemodes
      • (Editing these will not change the official gamemodes, they are for reference to use for making new custom modes)

Other Extension Plugins (EG. ChromaSparks)

These plugins are basically small, normal plugins, which you should install like any normal plugin, with only one exception: you must have Chroma installed to use them.

  • ChromaSparks

Changing Preferences Profile

Chroma uses its own .ini file instead of the ModPrefs for saving all the settings you choose. One cool thing about this is you can save multiple preferences and swap between them!

In your Userdata/Chroma/Preferences folder, you'll see an ini file (default.ini). This is where all your settings are stored. You can copy, edit, clone, whatever you want with this file (this is also useful if you want to get some specific settings that the in-game interface doesn't allow, for example, if you wanted to set your customHapticsDuration to 0.075 for whatever reason).

A common method of switching between these would be the usual approach of renaming files, but you can also simply go into your ModPrefs.ini (found in UserData), and under the [Chroma] section you'll see ConfigProfile. This is what tells Chroma what configuration file to use. You can simply change the name provided here to switch out your preference file!

Clone this wiki locally