wiki/Storyboard/Scripting/en.md CHANGED
@@ -1,34 +1,39 @@
1
1
  # Storyboard scripting
2
2
 
3
- ![An example of scripting in .osb](img/SBS_Base.jpg "An example of scripting in .osb")
3
+ ![Screenshot of a storyboard script open in "Code - OSS"](img/osb-example.png "Example of a storyboard script (.osb)")
4
4
 
5
- In addition to the [built-in storyboard editor](/wiki/Client/Beatmap_editor/Design), a plain text editor, such as Notepad, [Notepad++](https://www.notepad-plus-plus.org/), or [Visual Studio Code](https://code.visualstudio.com/), can also be used to create [storyboards](/wiki/Storyboard) for beatmaps. This workflow is called **storyboarding by scripting** (*SBS*) and it allows one to be more precise (to the pixel and the millisecond) as to when sprites appear, how they behave, and so on.
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
6
 
7
- To study a specific part of scripting, head to one of the articles below:
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
8
 
9
- - Basic concepts:
10
- - [General rules of storyboarding](General_Rules)
11
- - [Objects](Objects)
12
- - [Basic commands](Commands)
13
- - [Compound commands](Compound_Commands)
14
- - [Variables](Variables)
15
- - Extra:
16
- - [Playing audio](Audio)
17
- - [Storyboard scripting cheat sheet](Cheat_Sheet)
18
- - [osu! file toggles](osu!_File_Toggles)
19
- - [Short versions of commands](Shorthand)
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.*
20
10
 
21
- ## Overview
11
+ ## Concepts and file format
22
12
 
23
- There is an overview of the storyboard scripting concepts provided by [Doomsday](https://osu.ppy.sh/users/18983): [osu! - Storyboard Scripting for Beginners (12:22)](https://www.youtube.com/watch?v=UJ1YLDs-bZg).
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 -->
24
14
 
25
- ## Full specification
15
+ See the following articles:
26
16
 
27
- *Note: Save your work in the built-in editor first, as it optimises some things out, and only then in a plain text editor. **Save often** to prevent accidental progress loss.*
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)
28
26
 
29
- The storyboard scripting process is primarily based on [the official specifications](https://osu.ppy.sh/community/forums/topics/1869) and experience in making large storyboards. Although the osu! wiki articles provide simple examples, they are not step-by-step guides. Instead, the explanations aim to exhaustively detail how the basic scripting commands translate into the on-screen actions in osu!.
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! -->
30
28
 
31
- Before writing storyboard scripts, check [the terms and basic concepts](/wiki/Storyboard/Scripting/General_Rules) to prevent possible further issues and misunderstanding. For more in-depth explanations, see:
29
+ ## Community tools
32
30
 
33
- - [Storyboard objects](/wiki/Storyboard/Scripting/Objects)
34
- - [Storyboard scripting commands](/wiki/Storyboard/Scripting/Commands)
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
+ -->