Skip to main content

CLI

Create a new storyboard project​

npx osbjs create-storyboard [project-name]

This will generate the initial project structure and install all the needed dependencies. If project name is not specified, it will assume the project folder is the current directory where the command was executed.

components
├── Example.js
scenes
├── Main.js
index.js
osbjs.config.js

Once the folder are generated, update path and filename in osbjs.config.js and start coding!

Options:​

  • -d: Create a diff specific storyboard
npx osbjs create-storyboard -d
  • -t [template-name]: template name. available: common for CommonJS syntax, es for ESModule syntax, ts for TypeScript. Default: common
npx osbjs create-storyboard -t es
  • -c: if you don't want to generate example components.
npx osbjs create-storyboard -c

Customize a pre-built component​

In case you want to customize a pre-built component, run:

npx osbjs customize [name]

where name is the component name. Available components: background, hitobjecthighlight, lyrics. This will also install needed dependencies for that component.

Create a new component​

npx osbjs create-component [name]

This will create an empty component.

Create a new scene​

npx osbjs create-scene [name]

This will create an empty scene.