wiki/Storyboard/Scripting/en.md ADDED
@@ -0,0 +1,39 @@
1
+ # Storyboard scripting
2
+
3
+ ![Screenshot of a storyboard script open in "Code - OSS"](img/osb-example.png "Example of a storyboard script (.osb)")
4
+
5
+ **Storyboard scripting** is the process of editing osu! [storyboards](/wiki/Storyboard) via their [`.osb`](/wiki/Client/File_formats/Osb_(file_format)) and [`.osu`](/wiki/Client/File_formats/Osu_(file_format)) files. These files define images and effects that the [game client](/wiki/Client) renders into background animations during gameplay.
6
+
7
+ Scripting is a common alternative to [the game client's storyboard editor](/wiki/Client/Beatmap_editor/Design) when precision or complexity are required. With a text editor such as [Notepad](https://en.wikipedia.org/wiki/Windows_Notepad "\"Windows Notepad\" on Wikipedia"), [Notepad++](https://www.notepad-plus-plus.org/), or [Visual Studio Code](https://code.visualstudio.com/), storyboarders can edit the exact values of [objects](Objects) and [commands](Commands) instead of using on-screen controls. Many storyboarders also make use of [programming](https://en.wikipedia.org/wiki/Computer_programming "\"Computer programming\" on Wikipedia") to build storyboard files that would be difficult to create manually.
8
+
9
+ *Warning: Avoid editing storyboard scripts of a [beatmap](/wiki/Beatmap) currently open in the [beatmap editor](/wiki/Client/Beatmap_editor). Your work may be overwritten when saving the beatmap.*
10
+
11
+ ## Concepts and file format
12
+
13
+ <!-- storyboarding concepts should be at the same level as this article, and only details of scripting and the file format itself should be below this article, but sub-articles currently mix together this information -->
14
+
15
+ See the following articles:
16
+
17
+ - [General rules for storyboarding](General_Rules)
18
+ - [Objects](Objects)
19
+ - [Commands](Commands)
20
+ - [Compound commands](Compound_Commands)
21
+ - [Audio samples](Audio)
22
+ - [osu! file toggles](osu!_File_Toggles)
23
+ - [Variables](Variables)
24
+ - [Shorthand](Shorthand)
25
+ - [Cheat sheet](Cheat_Sheet)
26
+
27
+ <!-- (in a new section) seems like the place to link the top level of a storyboarding guide on the wiki... if there was one! -->
28
+
29
+ ## Community tools
30
+
31
+ <!-- as-is, this section's only purpose is to say that these projects exist (plus a popular example). this would be a good place to link away to other helpful projects or an article about them. -->
32
+
33
+ Various tools have been made by the community to abstract and build upon storyboard scripting, such as ::{ flag=FR }:: [Damnae](https://osu.ppy.sh/users/989377)'s [storybrew](https://github.com/Damnae/storybrew "GitHub repository").
34
+
35
+ <!--
36
+ might be useful reference for historical topics in/around this article
37
+ - first public sb specs https://osu.ppy.sh/community/forums/topics/1869
38
+ - first(or close to it) video tutorial about scripting https://www.youtube.com/watch?v=UJ1YLDs-bZg
39
+ -->