Skip to content

Commit d86d753

Browse files
authored
Added initial version of readme
1 parent bef96f2 commit d86d753

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# MovementScriptGenerator
2+
A tool to simplify the creation of movement scripts for Beat Saber
3+
4+
This tool enables you to create camera moves for the [Camera2](https://github.com/kinsi55/CS_BeatSaber_Camera2) mod and chain them together.
5+
This can be used to create interesting and complex shots for distinct maps (dance videos / lightshows / etc.) or simpler, repeating shots as general camera movement (streaming content)
6+
All of this on the same camera, without any editing afterwards.
7+
8+
Check out the [wiki](https://github.com/DragonirHD/MovementScriptGenerator/wiki) to find detailed explanations on how to use the tool.
9+
10+
See the promotional video [here](https://youtu.be/YGpfWJvm4Hs) to find out what the tool is currently capable of.
11+
12+
##Move Presets
13+
There are currently two supported move presets.
14+
Presets are here to make camera movements, which would otherwise be very difficult to make by hand, fast and easy to create.
15+
Each preset comes with a bunch of settings which can be tweaked to create tons of variations of the base moves.
16+
Explanations to the settings of each preset can be found in the tool itself, by hovering over the label/the name of the setting.
17+
18+
###Circle
19+
Creates a move, where the camera will circle around the player/avatar.
20+
Can be edited to make moves where the camera will only complete a certain percentage/Sector of the circle.
21+
22+
####Showcase
23+
![](Showcase/circle.gif)
24+
25+
###Spiral
26+
The camera will move on a straight line towards or away from the player/avatar.
27+
It can turn around its own axis multiple times on this path, creating a spiralling/corkscrew-like movement.
28+
This move can be placed everywhere around the player/avatar in the shape of a dome.
29+
30+
####Showcase
31+
![](Showcase/spiral.gif)
32+
33+
##Coming Features
34+
All of these features have no definitive release date and are currently only ideas for what might be made next.
35+
- A new field where it will be possible to chain moves together and edit the chain afterwards. (This will simplify the process of creating movements for entire songs)
36+
- saving and loading of moves
37+
- New Move: J-Turn
38+
- dark mode
39+
40+
##Why?
41+
I wanted to use movement scripts to enhance my own videos and add more dynamics to them.
42+
After trying to create a circular motion by hand in a movement script file and noticing that around 360 points would have to be defined
43+
I tried to do it programmatically to simplify the process.
44+
This idea culminated into this tool.

0 commit comments

Comments
 (0)