Home

Welcome to the synth_mapping_helper wiki!

See Installation and Usage on Windows to learn how to use this on Windows (even without having to use the command line).

If you are comfortable with the command line, you just need to install Python 3 (3.9 or later) and run pip3 install --upgrade synth_mapping_helper. Then you can run the tool from anywhere via python3 -m synth_mapping_helper.cli -h.

See the Glossary for info on how we handle coordinates and the different game objects.

I recommend you look at all pages at least briefly, there are a lot of options and most are too complex to explain sufficiently in a single line.
Also you may want to try out features on a dedicated test map first, as undo in the editor works most of the time, but not every time.

These options are supported in the order they are listed (alternative below):

1. Pre-Processing
   • Change BPM
   • Delete Everything Not Matching Filter
   • Connect Single Notes Into Rails
   • Merge Rails
   • Change Note Type
   • Swap Hands
   • Change Wall Type
   • Spawn object
2. Rails
   • Interpolate
   • Shorten Rails
   • Spiral (and zigzags)
   • Spikes (aka Buzz-Rails)
3. Movement
   • Scaling (also does reversing/mirroring with the right input)
   • Rotate
   • Offset (aka move/translate)
     • Can also be used to fix the positions of walls being different between editor and game
   • Outset
   • Stacking (aka cloning/tiling)
   • Autostacking
   • Following Notes (eg. stacking wall art along to the notes/rails)
   • Random Offset
   • Random Rotation
4. Post-Processing
   • Create parallel patterns
   • Split Rails
   • Convert Rails Into Single Notes
   • Snap Single Notes to Rails
   • Keep Selection Alignment (else selection start snaps to first note/wall)

If you want to execute them in a different order, you must do it in different commands (ie different lines in an action file).

There are also miscellaneous options which do not fit anywhere:

• Start with empty data (instead of read from the clipboard)
• Use Original JSON (so you don't have to undo/copy again for trying different parameters)
• Filtering (most options can be applied to specific note/wall types only)
• Mirror operations for the left hand (works on most things, including spirals/spikes)

Note that this wiki may be incomplete (Last updated for Version 1.3.0), and you may need to refer to the help command (show_help.bat or -h parameter) for more up-to-date information.