npm.io
0.8.5 • Published 2 years ago

@roudanio/lazy-melody

Licence
Version
0.8.5
Deps
9
Size
143 kB
Vulns
0
Weekly
0

Lazymelody.com

Development

Pre-requisites

  • node.js >= 16
  • pnpm >= 7
Setup
  1. Git clone this repo
  2. Install dependencies: pnpm i
  3. Start the development server: pnpm run dev

How to

Add a new score operator

A score operator is a function that takes a score and returns a new score. It is built with 3 parts:

  1. A score operator function, will do something to MusicNote
  2. A keyboard shortcut to trigger the operator
  3. A UI menu component (not implemented yet)
  4. Text to score parser
  5. Score to text generator
  6. midi-player
The Operator Function

For the operator function, it should follow this signature:

(selectedNots: MusicNote[]) => boolean;

It should:

  1. validate the input, return false if the input is invalid
  2. do the transformation, return true if the transformation is successful
The Keyboard Shortcut
The UI Menu Component

(Note: this is not implemented yet)