User Guide

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 from the releases page. (The zip file that is named something like "MovementScriptGenerator_vX.X.X".)
• unpack the zip file and start up the tool by double clicking the MovementScriptGenerator.exe file.
• If there's a message from windows titled "Windows protected your PC", click on "show more" and then "Run anyway". This happens because Windows doesn't recognise this application and thus can't verify that it is from the original author/creator. To make the application recognisable for Windows, it would have to be signed, which costs around 70$ per year to do. As this is just a small passion project, those costs would be to much currently.
• The tool should now be open and you should be able to create some camera moves.

UI Overview

Creating your first movement script

1. select the type of element you want to create, by clicking on the first box of the Element Settings with the label "Type" next to it.
2. Give the element a name by typing one into the field in Element Settings with the label "Name" next to it. (Can also be left blank)
3. Change the settings of your selected element type to your liking by editing the rest of the fields in Element Settings.
4. If you are done with the settings, click on the "Add" button in the Element Options #1. This will add your element to the Chain Window. You can add as many elements to the Chain Window as you want. You can also edit the Chain Elements with the buttons in Element Options #1 & #2.
5. If you are satisfied with your chain, you can go on to creating the movement script. For that, first give a fitting name to your script by writing it into the field in the Script Settings with the label "Script Name". This will be the name of the file that will be created. (Can be left blank)
6. Next click on the button next to it that says "Edit Script Path". Here you will be able to decide, where the script will be generated to. For most users, this would be the "MovementScripts" directory, that is automatically created if you have the camera2 mod installed. You want to have your scripts in this directory, because else camera2 will not be able to use them. The path should look somewhat like this: "C:\SteamLibrary\steamapps\common\Beat Saber\UserData\Camera2\MovementScripts".
7. If you have decided on a script name and path, you can click on the button "Generate script". This will generate your movement script file with the given name in the given directory. Now that you have a movement script, you will have to connect it with a camera.
8. Create a new positionable camera with camera2 and open up its .json file. You can also use an already created camera. The .json files of the cameras should be located in the same place as the movement scripts (see step 6.) just instead of "Camera2\MovementScripts" it should be "Camera2\Cameras". If you don't know how to edit cameras or have trouble finding the .json files, check out the wiki pages of the camera2 mod here or check out the guide video for camera2 of Fefeland here.
9. 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, separate 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)
10. Save your changes of the cameras .json file.
11. go into beat saber and check if the camera moves as it should. (Try reloading the scripts ingame by pressing ctrl + shift + f1)
12. Make sure that the camera is active in the correct scenes. Else it might not move.

Saving the Project/Chain

1. Create a chain and add some elements to it.
2. Give your new chain a name by filling out the field in the Chain Settings that has the label "Name". (Can be left blank)
3. In the Tool Strip, click on "File" and then on "Save" / "Save As".
4. Choose where the file should be saved.
5. Now that the file is saved, you can always load it again by clicking on "File" in the Tool Strip again, then clicking on "Open" and select your file.This will load your chain and all the chain elements into the tool. (The Script settings will currently not be saved with this. They have to be applied each time when starting the tool.)

Tips

• All settings and most buttons have a tooltip/description on them, explaining how they work or what they do. To make the tooltips visible, point the mouse cursor onto the corresponding labels. (For tooltips of buttons, just point it onto the button itself.)
• 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 multiple camera moves on one camera, just chain them together or add them to an already created script by checking the box with the label "Add to existing Script" in the Script Settings, setting the script name to the already generated script and then generating the script. (Beware that you can't remove any elements from an already generated script. Only adding more elements is currently supported.)
• You can get a chain elements settings by double clicking it in the Chain Window.
• If you want to create camera moves for one particular song, make sure to set the setting "enableInMenu" in the json script of your camera to false. Else restarting a song can have weird effects on the camera, as it will sometimes transition from its last place before the restart, to the actual starting place.
• Spiral moves can easily be turned into linear moves or point moves. If you set the "Spiral Ammount" setting to 0, the camera will move in a line. If you now also set "Start Distance" and "End Distance" to the same value, the camera will stay in the same place.

Deleting the Tool

Normally you can just delete the folder, in which the .exe file is located. If you also want to delete the user settings, which are some smaller files that have some of your settings saved (window size, last chain edited, etc.), then follow these instructions:

1. On your keyboard, press the windows button + r.
2. Now type "%appdata%" into the dialog that opened and hit enter. This will open up file explorer on a directory called "Roaming".
3. From here, go back one directory into the "AppData" directory.
4. Open up the "Local" folder and then inside of it there should be a folder called "MovementScriptGenerator" which you can delete. The folder "MovementScriptGenerator" has all the other files inside. By deleting this folder and the folder with the .exe file in it, all the data of this tool will be removed from your device.