Giter VIP home page Giter VIP logo

musje's Introduction

musje NPM version Build Status Dependency Status

Musje - 123 jianpu music processor.

Musje consists of

  • parser
  • model
  • renderer
  • player

Checkout http://jianpu.github.io/musje/demo/ for demo.

Install

Musje depends on Snap.js for rendering and MIDI.js for playing. It shall have bower support in the future.

Usage

var score = musje.parse(musjeString);
score.render(svgSelector, layoutOptions);
score.play();
score.stop();

Another way to build a song is using JavaScript object obj or JSON jsonString.

var obj = {
  head: {
    title: 'the title',
    composer: '...'
  },
  parts: [{
    measures: [
      { data: [musicData11, musicData12, ...] },  // a measure
      { data: [musicData21, musicData22, ...] },  // another measure
      ...
    ]
  }, {
    measures: [
      data for the second part
    ]
  }]
};
var score = musje.score(obj or jsonString);

Documentation

http://jianpu.github.io/musje/doc/

Develop

Install

Install node.js first, and install gulp globally

npm install -g gulp

Clone this repo, and in the project folder run

npm install

Build

Build both the musje library and documentation.

gulp build

Build the musje library.

gulp build-musje

Build the musje documentation.

gulp build-doc

Or watch the documentation build during development.

gulp watch-doc

Demo

Serve and watch demo of the musje library with live-reload, useful for the developing process.

gulp

or

gulp watch-demo

Test

Run either of the following for testing.

gulp test

or

npm test

Watch the test.

gulp watch-test

License

MIT License

musje's People

Stargazers

ZD avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.