Skip to content

User Guide

Jump to bottom
DragonirHD edited this page Dec 4, 2022 · 20 revisions

User Guide

Contains useful information and explanation on how to use the tool.

Installing and using the tool

Quick explanation on how to install the tool and start creating:

  • Download the zip file of the newest version of the tool in the releases page
  • unpack the zip folder and start up the tool by opening the MovementScriptGenerator.exe file.

The tool should now be open and you should be able to create some moves.

Creating your first move

  • check the path at the bottom of the window. The movement scripts will be created in this path. Make sure that this path exists on your computer. If not, edit this setting so that it points to the correct directory.
  • select the type of move you want to create, by clicking on the first box with the label "Move Type" next to it.
  • define a file name for your movement script in the box with the label "File Name" next to it.
  • Edit the settings of your selected move type to your liking.
  • If you are done with the settings, click on the "Generate" button. This will create a file with your given file name in the given path.
  • Create a new positionable camera with camera2 and open up its .json file. You can also use an already created camera. If you don't know how to edit cameras or where the .json files are, check out the wiki pages of the camera2 mod here or check out the guide video for camera2 of Fefeland here.
  • In the .json file, go to the "scriptList" part. inside the square brackets write the name of your movement script file with quotation marks. If you want to add multiple movement scripts to a camera, divide them with commas. (The last entry should have no comma after it) In the end it should look something like this. (example has two movement scripts added) TIP: If you have multiple movement scripts on a camera, they will not play one after another. Instead a random one will play at every new scene load. If you want to chain moves together, check out the move chaining page
  • Save your changes of the .json file.
  • go into beat saber and check if the camera moves as it should.
  • Make sure that the camera is active in the correct scenes. Else it might not move.

Tips for working more efficiently with the tool

  • For trying out moves and tweaking the settings, so that it looks the way you want it to, I found that this works best.
  • Start up beat saber in fpfc mode (on steam, right click beat saber and go to properties. There add fpfc into the launch options. This will launch beat saber in the desktop mode)
  • Go to the camera2 mod window and create/select the camera you want to add the moves to.
  • Open up the MovementScriptGenerator tool on a second monitor or over the beat saber window and create a movement script.
  • connect movement script and camera.
  • In beat saber, press ctrl + shift + f1 to reload the cameras. This way, the camera should start doing the move you created.
  • If you now want to change up the move, just switch back to the MovementScriptGenerator tool and change the settings.
  • Hit generate again. If you haven't changed the file name, it will overwrite the old file. This way you don't have to connect camera and movement script again.
  • Go back into beat saber and reload the cameras again. The camera now should use the new settings.

Clone this wiki locally