osu-wiki
osu-wiki copied to clipboard
Update/rewrite the storyboarding articles
all the guides and specifications on wiki are 5 to 10 years old, if not more. granted, the specs haven't changed over the time, but the approaches have.
I have no specific action items, only a list of things that should be mentioned somewhere, possibly in a separate article (something like "best practices"):
- history of storyboarding: strager's osq2osb (I think it was called that, or just osq), Moonshade's SGL, Wafu's osbpy and SGL optimization article, Damnae's storybrew
- relatively modern concepts, like particle systems, spectrums, 3d models and stuffs
- tools such as storybrew (can't stress its importance enough), OSB optimizer, particle and spectrum generators, whatever floats nowadays
- things from https://osb.moe/learn/ (these could probably be incorporated into the existing articles directly)
- anything from Damnae's storyboarding server
slightly related: #974
I've been planning on a rewrite of the entire storyboarding section of the wiki (over a few more months than I'd like to admit). Below is a blueprint of what should be where. Suggestions and additions are welcome! I intend to be working on this over the coming couple months (or a few short bursts, depending on how I manage my other projects)
Structure
-
Storyboarding-
Specifications-
Scripting_languageContains syntax specifications only, and links to additional information in `Concepts`; `Client/osu!_File_Formats/Osb_(file_format)` would link here
- Sprites
- Animations
- Samples
- Events
- Move
- MoveX
- MoveY
- Fade
- Rotate
- Scale
- ScaleVec
- Color
- Parameters
- Additive
- FlipH
- FlipV
- Shorthand
- Loops
- Triggers
- Hitsounds
- Game state transition
- Variables
- Indentation
- Comments
-
ConceptsBasically an appendix to `Scripting_language` that explains how storyboards work
- Coordinate space
- Easing
- Link to easings.net
- List all easings used in osu!
- Origin
- Layers
- Background
- Fail
- Pass
- Foreground
- Overlay
- Draw order
- Sprite active time
- Event overlap
- Event incompatibility
- Game state
-
osu!_file_toggles(need a better name)Things specified in `.osu` files that are related to storyboards
- Video
- Background
- WidescreenSupport
- UseSkinSprites
-
-
TechniquesDistinct techniques to that people have been using in storyboards
- Particle systems
- Spectrums
- 3D models
- Tiling backgrounds
- Sprite splitting
- Masking
-
OptimisationThings to look out for that affect the performance of storyboards
- Unused files
- File size
- Redundant events
- Overlapping events
- Invisible sprites
- Looping and event splitting
- SB load
- Out of bounds sprites
- Tools
- OsbUtilities by Endaris (2020)
- OSB optimizer by yf_bmp (2016)
-
Best_practicesA basic tips and tricks section for things that should be standard (unsure if this should exist; could also be in `Guides`)
- Anti-aliasing artifacts
- Easing usage
- Effect timing
- link to
Optimisation
-
-
Storyboard- Overview, storyboards in iNiS games
Changelog_of_storyboard_features- Eventual classification of storyboards (maybe authentic, simple, complex, gameplay gimmicks, etc. in similar vein to
Beatmap)
-
Projects#StoryboardingCreation tools
- dotosb by PoNo (2022)
- sbtw! by Nitrous (2021)
- osbjs by Smug Nanachi (2021)
- osb.h by PoNo (2021)
- OSBX by PoNo (2021)
- OSU storyboard Engine by Yumeno Himiko, yf_bmp, and [Mahua] (2018)
- Taiko Mod Generator (TMG) by Yuzeyun (2017)
- Storybrew by Damnae (2016)
- lyricsGenerator by XinCrin (2016)
- osbpy by Wafu (2016)
- particleGenerator by XinCrin (2015)
- spectrumGenerator by XinCrin (2015)
- Spectrum Diagram Generator by ITer (2015)
- Lyric Generator by pandorawindy (2015)
- The Lua Storyboarding System (LSBS) by Agka (2012)
- osu!dots by Astom (2011)
- .osb code helper (osbch) by YUI (2011)
- Storyboard Generation Language (SGL) by MoonShade (2011)
- oosbl by Aqua (2011)
- osu! Storyboard Script Editor by MoonShade (2011)
- LyricsCodeGenerator by Astom (2011)
- osq2osb by strager (2010)
Optimisation tools
- OsbUtilities by Endaris (2020)
- OSB optimizer by yf_bmp (2016)
Rendering tools
- osb2mp4 by Walavouchey (2020)
- ReOsuStoryboardPlayer by DarkProjector (2017)
-
Client/osu!_File_Formats- (client directory because of https://github.com/ppy/osu-wiki/issues/6080)Osb_(file_format)- Link toStoryboarding/Specification/Scripting_language
-
Guides#StoryboardingFirst step would be to just list resources, and the next would be to write guide articles
- Link to Design tab
- wiki.osbx.org articles by PoNo
- Storybrew GitHub and wiki
- osb.moe articles by Endaris (i think)
- Video tutorial by -Tochi
- [Official Specifications] Storyboarding by Scripting by Echo
- osu! - Storyboard Scripting for Beginners by Doomsday
- [Guide] How colorization works in osu! by ziin
- [Tutorial] Basic Manual Storyboarding Guide by Kite
- VenerableNyanta's sb class lecture recordings in the Avalon Discord server (in progress)
-
wiki/Contests#Storyboarding
Formatting
Formatting conventions I intend to use that don't appear in the Article Styling Criteria.
- Syntax specifiers should always be in
code-blocks, with variables in camelCase enclosed with curly braces ({}) (honestly this should apply everywhere in the wiki), followed by a list explaining the variables Hit object syntax:{x},{y},{time},{type},{hitSound},{objectParams},{hitSample}
Remarks
osu!_File_Formats/Osb_(file_format)is currently just a stub that links toStoryboard. For this structure, it would still just link toStoryboarding/Specifications/Scripting_language, but this could alternatively work in reverse.Storyboarding/Best_practiceswould basically be a glorified guide, and although I don't currently know what should be mentioned there, it could be a good "things you should know" section detailing common pitfalls and things to avoid (withOptimisationcontaining more details on that)- I'm pretty much of the opinion that
Storyboarding/Specifications/Scripting_languageshould be a single article, not split up into lots of pieces (it should be a reference sheet), whileStoryboarding/Specifications/Concepts(name suggestions welcome) can be split up into multiple articles since there can be more in-depth information here, but I'm not sure yet. Storyboarding/Specificationsgroups together the related sections (a lot of technical information)- This separates this section of the wiki into
StoryboardingandStoryboard, just likeBeatmappingandBeatmap, which I think is definitely the way to go.
very well thought out. one thing is that I had to merge Storyboarding and Storyboard in the past due to lack of content in the former — hopefully your work will allow these two to coexist as different articles again
https://twitter.com/tochiiDesign/status/1668759156126543872