notOSU! - A Tool for Dynamic osu!mania Storyboarding

Welcome to notOSU!, an innovative tool designed to enhance your storyboarding experience in osu!mania. This README provides guidance on setting up and configuring notOSU! for your storyboard projects.

Getting Started

notOSU! Documentation.

Step 1: Downloading notOSU!

Begin by downloading the latest release of notOSU!:

• Visit the official repository.
• Choose the most recent version to access the latest features.

Step 2: Installation

After downloading, integrate notOSU! into your storyboard environment:

• Find the /scriptLibrary directory in your storyboard project.
• Extract and place the downloaded notOSU! folders into the /scriptLibrary directory.

Congratulations! The initial setup of notOSU! is now complete.

Configuring a Playfield for Storyboarding

Creating a dynamic storyboard in notOSU! involves setting up layers, a playfield instance, and a DrawInstance.

Required Components:

1. Layers: Define layers for receptors and notes.
2. Playfield Instance: Manage the gameplay area and note mechanics.
3. DrawInstance: Handle the drawing and animation of notes.

Example Configuration:

var receptors = GetLayer("r");
var notes = GetLayer("n");

// General configuration values
var starttime = 0;
var endtime = 24000;
var duration = endtime - starttime;

// Playfield size
var width = 200f;
var height = 500;

// Note initialization
var bpm = 190f;
var offset = 0f;

// DrawInstance settings
var updatesPerSecond = 50;
var scrollSpeed = 800f;
var rotateNotesToFaceReceptor = false;
var fadeTime = 60;

var receptorBitmap = GetMapsetBitmap("sb/sprites/receiver.png");
var receptorWidth = receptorBitmap.Width;

Playfield field = new Playfield();
field.InitializePlayField(receptors, notes, starttime, endtime, width, height, 50);
field.InitializeNotes(Beatmap.HitObjects.ToList(), bpm, offset, false, sliderAccuracy);

DrawInstance draw = new DrawInstance(field, starttime, scrollSpeed, updatesPerSecond, OsbEasing.None, rotateNotesToFaceReceptor, fadeTime, fadeTime);

draw.DrawNotesByOriginToReceptor(duration);

Follow these instructions to effectively set up your notOSU! Playfield and Notes for storyboard creation.

Documentation and Community Support

For detailed guidance and advanced features, refer to the notOSU! Documentation. Join our community on Discord for support, collaboration, and sharing ideas with fellow storyboarders.

Start your creative journey in osu!mania storyboarding with notOSU! today!