https://github.com/lenitrous/sbtw
The ultimate storyboard editor for osu!
https://github.com/lenitrous/sbtw
Last synced: about 2 months ago
JSON representation
The ultimate storyboard editor for osu!
- Host: GitHub
- URL: https://github.com/lenitrous/sbtw
- Owner: LeNitrous
- License: mit
- Created: 2021-11-14T10:48:59.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2022-02-20T22:23:04.000Z (over 3 years ago)
- Last Synced: 2025-04-16T11:06:38.563Z (about 2 months ago)
- Language: C#
- Size: 4.22 MB
- Stars: 18
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/lenitrous/sbtw)
[](https://github.com/lenitrous/sbtw)
The Storyboard Translation Workspace (sbtw!) is an osu! storyboard editor for generating storyboards with scripts written in many scripting languages. It uses [osu! (lazer)](https://github.com/ppy/osu) as its base. It is inspired by [storybrew](https://github.com/Damnae/storybrew) by Damnae.
### Languages Supported
- Javascript
- Typescript
### Notes
- **This project is heavily being worked on and many things such as project structure and scripting syntax may change without prior notice. You have been warned.**
- When running on Linux please take note of the following:
- Install a system-wide FFmpeg installation available to support video decoding.
- `kdialog` or `zenity` is required for displaying dialogs.
- You can use any text editor that has syntax highlighting for convenience however it is highly recommended to use any of the supported code editors listed below to support Intellisense for built-in documentation support.
- [Visual Studio Code](https://code.visualstudio.com/)
- [Atom](https://atom.io/)
- [Sublime Text](https://www.sublimetext.com/)
## Building
You can clone this repository using git or by downloading a copy. However there are some prerequisites that must be met before proceeding.
- [.NET 6.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/5.0) or later
- [Visual Studio Code](https://code.visualstudio.com/)
- see [this article](https://code.visualstudio.com/docs/languages/csharp) for preparing Visual Studio Code in building C# projects.
You can then run the project by running this at the root:
```
dotnet run --project desktop/sbtw.Desktop.Windows
```
Alternatively, you can run this command if you are on Linux:
```
dotnet run --project desktop/sbtw.Desktop.Linux
```
## Contributing
### Issues
Found an issue? Head over to the [issues page](https://github.com/LeNitrous/sbtw/issues) of this repository and create a new issue.
### Pull Requests
Want your changes to be pushed upstream? Make a pull requests with details on how it helps out sbtw!.
## License
sbtw!'s code is licensed under the [MIT License](https://opensource.org/licenses/MIT). See the [license file](./LICENSE) for more information. [tl;dr](https://tldrlegal.com/license/mit-license) you can do whatever you want as long as you include the original copyright.
This project uses [osu!resources](https://github.com/ppy/osu-resources) for the greater majority of its visual elements and is not a part of the license above. Additionally, this project is not affiliated with "osu!" or "ppy".