Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danigb/music.key
Music keys
https://github.com/danigb/music.key
Last synced: 13 days ago
JSON representation
Music keys
- Host: GitHub
- URL: https://github.com/danigb/music.key
- Owner: danigb
- Created: 2015-11-16T10:18:20.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-11-19T14:36:45.000Z (about 9 years ago)
- Last Synced: 2023-04-11T13:58:27.206Z (over 1 year ago)
- Language: JavaScript
- Size: 90.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
Awesome Lists containing this project
README
# music.key
[](https://travis-ci.org/danigb/music.key)
[](https://codeclimate.com/github/danigb/music.key/coverage)
[](https://codeclimate.com/github/danigb/music.key)
[](https://github.com/feross/standard)
[](https://www.npmjs.com/package/music.key)
[](https://www.npmjs.com/package/music.key)
[](https://www.npmjs.com/package/music.kit)
`music.key` is a collection of functions to create and manipulate music keys:
```js
var key = require('music.key')
key('###') // => 'A major'
key.signature('A major') // => '###'
key.altNotes('A major') // => ['F#', 'C#']
key.relative('minor', 'A major') // => 'F minor'
key.scale('A major') // => ['A', 'B', 'C#', 'D', 'E', 'F#', 'G#']
key.chords('A major') // => ['A', 'Bm', 'C#m', 'D', 'E7', 'F#m', 'G#o']
```
This is part of [music.kit](https://github.com/danigb/music.kit)
## Installation
Not yet released.
## User guide
#### Valid keys
A key in `music.key` is a string with a tonic and (optionally) a mode: `'C'`, `'C major'`,`'C minor'`,`'Ab dorian'` are valid keys. The valid modes are: `major`, `minor`, `ionian`, `dorian`, `phrygian`, `lydian`, `mixolydian`, `aeolian` and `locrian` (`major` if not specified).
#### Create keys
The key function returns a key from a name or from a signature:
```js
key('C major') // => ['C', 'major']
key('C') // => ['C', 'major']
key('Cb dorian') // => ['Cb', 'dorian']
key('#') // => 'G major'
```
#### Relative keys
You can get relative keys:
```js
key.relative('minor', 'C major') // => 'A minor'
key.relative('minor', key('#')) // => 'E minor'
```
This function can be partially applied:
```js
var minor = key.relative('minor')
minor('C major') // => 'A minor'
```
#### Get key signature and altered notes
The key signature is a string with the flats or sharps:
```js
key.signature('F major') // => 'b'
key.signature('Eb major') // => 'bbb'
key.signature('A major') // => '###'
key.altNotes('F major') // => ['Bb']
key.altNotes('Eb major') // => ['Bb', 'Eb', 'Ab']
key.altNotes('A major') // => ['F#', 'C#', 'G#']
```
The altered notes are returned in its proper order:
```js
key.altNotes('F major') // => ['Bb']
key.altNotes('Eb major') // => ['Bb', 'Eb', 'Ab']
key.altNotes('A major') // => ['F#', 'C#', 'G#']
```
#### Get key scale and chords
This is pretty straightforward:
```js
key.scale('C major') // => ['C', 'D', 'E', 'F', 'G', 'A', 'B']
key.chords('C major') // => ['CM', 'Dm', 'Em', 'FM', 'G7', 'Am', 'Bdim']
```
The key chords are strictly the ones derived from the scale. For example, V chord in minor key is a minor chord (take a look to [music.harmony]() for more advanced uses)
#### Progressions
Get chords from a key using roman numerals:
```js
key.progression('II V I III VI', 'C major') // => ['Dm', 'G7', 'CM', 'E', 'F']
key.progression('II V I bIII VI', 'C minor') // => ['Ddim', 'G7', 'Cm', 'Eb', 'Fm']
```
You can use bars to separate romans:
```js
key.progression('II V | I', 'Ab major') // => ['Bbm', 'Eb7', 'AbM']
```
## Documentation
Read the [user guide](https://github.com/danigb/music.key/blob/master/GUIDE.md)
or the generated [API documentation](https://github.com/danigb/music.key/blob/master/API.md)
## License
MIT License