Getting Started

1. Download the latest version.

2. Install Visual Studio Code.

   Make sure to either check the "Add to PATH" option, or to install it in its default location so storybrew can find it.

   You can use other versions of Visual Studio, but they are much heavier to install. Any text editor can be used to edit scripts, but you'd be missing IntelliSense (word completion, parameter hints, etc.). Visual Studio Code is also better integrated for script creation/editing.

   Once you have Visual Studio Code installed, you should download some extensions for C# programming to be able to see what functions, methods, and variables you have access to. You should install C# alongside the C# Dev Kit, an extension made by Microsoft to aid in C# development. Another popular extension is C# Snippets which can generate common boilerplate code, however this is not necessary for your Storybrew experience.

3. Install .NET SDK 8.0.8 x86 (or more recent). ⚠️Do not get the x64 version⚠️

4. Launch Storybrew Editor.exe and click on New project.

5. Choose a name for the project and select the mapset by picking any .osu file inside it.

6. Storyboards are made of multiple effects; to create a new effect, click on the Effects tab on the bottom right, then New script.

7. Pick a name for the script, then click Ok. The script will open in Visual Studio Code where you can edit it.

8. The first time you open a script in Visual Studio Code, it will ask you to install the C# extension (If it doesn't, press Ctrl-P and type ext install csharp). After restarting, your code should be syntax colored (= not completely white).

9. Here's a sample script, copy it inside the Generate method (make sure the path to the background image is correct).

   var layer = GetLayer("Main"); //This creates a StoryboardLayer that you can create sprites with.
   var bg = layer.CreateSprite("bg.jpg", OsbOrigin.Centre); //This creates an OsbSprite that contains data about the sprite
   bg.Scale(0, 480.0 / 768);
   bg.Fade(0, 2000, 0, 1);
   bg.Fade(8000, 10000, 1, 0);
   

10. The result will be visible in the editor as soon as you save the script. You can use the mouse wheel or arrow keys to move in time and see the background fading in and out. You can also press space to play the song.

11. Click the puzzle piece in the bottom right to write the .osb file.

12. Your storyboard is now working in osu!