Remove github mirror buildscript
~shunter pushed to ~shunter/kablature git
New mailing list added4 months ago
Command-line tool to assist creating Kalimba tablatures.
Kablature requires Quicklisp to compile. While it tries to be portable with other implementations, it assumes SBCL as its compiler, and I'm making no personal effort to test it on other implementations for the time being.
Compiling with Make:
$ make $ make examples # compile all example tab files. $ sudo make install
Compiling with Common Lisp (SBCL):
* (load "kablature.asd") # or move it to ~/quicklisp/local-projects * (ql:quickload :kablature) * (asdf:make :kablature) # Build the program in the project root.
Convert a tablature file into a visual SVG. Usage: ./kablature [-h|--help] [-o|--output OUTPUT] [-b|--bars BARS] FILE Available options: -h, --help Print this help text -o, --output OUTPUT Place output into OUTPUT (default standard output) -b, --bars BARS Force the tablature output to a specific number of bars per staff. If FILE is not provided, kablature reads from standard input.
A tablature file is a symbolic expression, like Lisp:
(:deftablature "Happy Birthday" (:timesig (3 . 4) :keys 17) (2 nil) (8 t 1) (16 nil 1) (4 nil 2) (4 nil 1) (4 nil 4) (2 nil 3) (8 t 1) (16 nil 1) (4 nil 2) (4 nil 1) (4 nil 5) (2 nil 4) (8 t 1) (16 nil 1) (4 nil 8) (4 nil 6) (4 nil 4) (4 nil 3) (4 nil 2) (8 t 7) (16 nil 7) (4 nil 6) (4 nil 4) (4 nil 5) (2 nil 4) (4 nil))
The first argument is the name of the song (currently not used, but is planned to be printed at the top of the file).
The second argument is a property list of the following optional values:
:timesig (beats-per-bar . beat-root)- A time signature of 4/4 and 3/4 would look like
:timesig (4 . 4)and
:timesig (3 . 4), respectively. The default is a 4/4 time signature.
:keys KEYS. The number of keys that the kalimba tablature will have. The default is 17, the number of keys on my own kalimba.
:bars-per-staff. The program will automatically split the tablature into multiple staves as best as they can, but you can force it to a specific number of beats per staff. Any non-positive integer will force the tablature into a single staff.
:repeats (BEGIN END ...)- Accepts pairs of bar numbers (e.g.
:repeats (1 2 3 4)) that marks the interval between beginning and end repeat marks.
:accidentals STRING- Accepts a seven-char string positionally symbolic to
-describes a natural,
brepresents a flat, and
#represents a sharp.
"-----#-"represents a G major with an F#, whereas
"bb--b--"represents a C minor with A, B, and E flats.
Within the body of the expression, there are two types of structures: chords and beamed groups.
Chords follow the syntax
(note-type dotted? keys...).
can be of 1,2,4,8, and 16 to describe that it's a whole, half, quarter
dotted? is a boolean
nil value describing whether
it's a dotted note.
keys can be a list of integers from
1 to the
number of keys on the tablature, describing which keys that the note
(4 nil 1) describes a quarter note that plays the first
key on the kalimba.
(8 t 1 3 5) describes a dotted eighth note that
plays keys 1, 3, and 5 together.
(2 nil) describes a half note that
plays no keys -- implicitly, a rest.
Beamed groups follow the syntax
(:beamed ....). Chords can only be
non-rest eighth and sixteenth notes, and describes that the notes are
grouped together by a beam instead of lonely flags for each note.
For example, while
(8 nil 1) (8 nil 3) describes two lonely eighth
notes and draws the flags for each individual chord, `(:beamed (8 nil