Workflow
This page describes the basic workflow for creating and performing scores in OscillaScore. It focuses on the minimum steps needed to get from drawing to performance.
1. Create a Project
Projects live inside:
public/scores/
Create a folder, for example:
public/scores/myProject/
Inside that folder create the main score file:
score.svg
This is the only file required for a project to work.
Optional files and folders
Other resources are only needed if your score uses them:
myProject/
├── score.svg # required
├── settings.json # auto-generated by Preferences
├── pages/ # only if using page-mode SVGs
├── audio/ # only if using local audio
├── texts/ # only if using external text
└── videos/ # only if using local video
settings.json is created automatically the first time you use the Preferences dialog (hamburger menu, top-right).
2. Author the Score in Inkscape
- Open Inkscape.
- Draw shapes, text, and paths. Lay out the score visually.
- Save directly into your project as:
public/scores/myProject/score.svg
Continue working in that file.
3. Add Behaviour Using IDs
Assign behaviour by editing element IDs in the XML Editor:
- Ctrl + Shift + X
Examples:
- pause(dur:12, count:true)
- audio(file:intro_theme.wav)
- o2p(path:p01)
- scale([1,1.3,1])
For full cue and animation syntax, see:
https://robcanning.github.io/oscilla/docs/
4. Open the Project in OscillaScore
You can open projects in either of two ways.
Direct URL:
http://localhost:8001/?project=myProject
Or via the loader:
- Visit:
http://localhost:8001
- Select your project in the loader dialog.
Oscilla automatically loads score.svg and any media if present.
5. Test and Iterate
Check:
- cue timing
- animation behaviour
- readability across devices
- whether external media loads
- overall pacing
Edit in Inkscape, save, refresh the browser, repeat.
Quick edit loop
In practice:
- Make a change in Inkscape
- Save
- Refresh the browser
The change appears immediately.
6. Rehearsal and Performance
Open the same project on each device and read from the score.
Timing and navigation follow the authored cues.