Modding Your Map (WIP) - UGEcko/Chroodle GitHub Wiki
Notice: This page is subject to change at any time, and is super incomplete. Do not use this yet
Hey you!
Would you like to create a map with dumb funny goofy notes that jiggle before you hit them? Or perhaps you're going for badass status and you'd like to create your own custom environment? You're in the right place! This page includes information that was made specifically for new modders who would like to enter the scene.
Here you will first learn about the basics of a beatmap to initialize your understanding on beatmap structure (Some of you don't even know about this file because you just map it, light it, and send it off! This is very different as modding your map involves a great involvement of modifying the difficulty file data. Knowing atleast the basics is essential if you are committed to making modded content.)
We will then bridge from that to introduce new concepts like Custom Data, Custom Events, and of course the mods that are behind these features! Its encouraged to further check out any websites referenced here. A majority being from the BSMG Wiki.
Ever wonder how a file turns into a BeatSaber map or what the data inside of the file translates to? Here you learn (most) of what it does!
When creating a map, you need to create 3 files that makeup your map, those being: The Song file, The Info File, and The Difficulty File. (I will be using "Difficulty" and "Diff" for short interchangeably).
For this guide, we will touch on the difficulty file the most, and only a teeny bit on the info file ( For requirements, and map structure ).
For starters, the difficulty file is used to map data that is to be displayed in the map (Notes, Bombs, Walls, Light Events, etc..) It is in the form of a JSON (learn about the basics of JSON here). Beatmap objects like notes and walls are separated into arrays, and their objects are defined. One important thing to note is beatsaber versioning. Currently, there is Beatmap V2, V3, and V4.
V3 is the most active and stable version currently out. You MUST make sure your difficulty is formatted for whichever version you're using. V4 will not be covered due to its lack of mod support and its major changes to the file structure.