Guest
home
beatmaps
rankings
community
store
help
forum
  1. Forums
  2. Beatmaps
  3. Mapping Discussion
  4. Storyboarding

OSBX - A Modular and collaboration friendly Typescript storyboard generator.

posted
Total Posts
7
PoNo
504 posts
Joined July 2014
Topic Starter
PoNo
Hey storyboarders!

I'm happy to share with you my new project freshly made and available very soon! OSBX is a typescript framework that is used to generate osu! storyboards in a new way!

The key feature, which makes OSBX different from other tools like SGL / osb.py and storybrew is that you create storyboards using Plugins, which you can create on your own, or import from the community. It might sound not a lot at the first place, but you could image simply grabbing a Plugin that generates a whole effect made by someone else and use it on your storyboard! Which can save you a lot of time, and be really useful to non-technical people.

Here's a short video that shows the current state of the project:
https://streamable.com/tf5nz7

----------

Technical specifications:

- OSBX is made to run on every OS such as Windows Mac and Linux, it will simply require you to download NPM and install the osbx-cli package on it!

- The plugin storage will be free and available to everyone for pushing, maintaining and grabbing plugins from the community!

- Of course, OSBX runs on NodeJS which is really helpful for asynchronous generation. Also with Nodemon, you just have to save your scripts and your storyboard will automatically regenerate!

- Github of the project: https://github.com/osbx/osbx
----------

There'll be more to come soon!
Happy codding :)
Last edited by PoNo , edited 1 time in total.
aiq
924 posts
Joined February 2019
aiq
nice
PoNo
504 posts
Joined July 2014
Topic Starter
PoNo

1.0.0 UPDATE - First stable version

The first stable version of OSBX is now available, including a CLI to help you create your projects using a terminal.

You can now:
  1. Create your projet using osbx-cli
  2. Generate every types of commands for a single osb file (diff specific not supported yet) except Trigger commands

How to install and setup osbx

Installing osbx is very easy and only require few steps to do. First of all install NodeJS on your computer https://nodejs.org/en/download/. For Linux users you can install Node using your favorite package manager.

Once Node is installed on your machine, you can download a text editor such as VSCode, VIM or Emacs. VSCode is a good solution because of his integrated terminal.

From a terminal, you can now run the command: npm i -g osbx-cli nodemon ts-node this will install you the osbx cli and its dependencies to make it work.

When osbx-cli is installed you can simply use the command osbx create-project and follow the instructions, I recommend installing osbx with a component if you're not familiar with the environment.

The CLI have now installed a new project with the name of it, you can access into it and launch npm run storyboard to start creating your project! When you save a file, it'll automatically update your osb file.

More precision will come in the future

Happy storyboarding :)
Last edited by PoNo , edited 1 time in total.
PoNo
504 posts
Joined July 2014
Topic Starter
PoNo

1.2.0 UPDATE - Added beatmap support (unfinished)


The 1.2.0 version is now available on npmJS, this version give you the opportunity to retreive data from a difficulty .osu file. This can be useful to generate quickly sprites on hitobjets.

This version is still missing some important features of the beatmap reading concept such as:
- Parsing slider data
- Generating storyboards in diff specific .osu

Do not hesitate to ask if you need further informations about the project!

https://github.com/osbx/osbx

I'll probably work on wiki stuff to help initializing the project and its features.

Happy storyboarding :)

Last edited by PoNo , edited 3 times in total.
TicClick
Global Moderator
4,416 posts
Joined February 2011
TicClick
language choice aside, the concept of modular storyboards sounds cool. hope your project takes off
McEndu
825 posts
Joined March 2019
McEndu
GitHub repository has moved to the osbx organization.

https://github.com/osbx/osbx

Can it generate standalone .osb files, anyway?
Last edited by McEndu , edited 1 time in total.
PoNo
504 posts
Joined July 2014
Topic Starter
PoNo
It depends what do you mean exactly by standalone? Just an osb file without depending on a specific map? If that is your question, not really, it always ask for a beatmap to generate osb file in it. But I can add an option for that.

Also thank you for indicating the new repo, gonna edit the post.
Last edited by PoNo , edited 1 time in total.
Please sign in to reply.

New reply

0
1 / 7