To contribute to this project you have to:
- Fork this repository
- Create a directory with the name of the instrument
- Create a sampled.json file with metadata information
- Create a subdirectory called samples with the audio files
- Run
npm run build - Make a pull request
The information is stored in a file called sampled.json. With this information, the build process create some other sampled.*.json files with additional information. The most important is the sampled.instrument.json which contains a list of all audio files.
The sampled.json file must contain:
- description: A text description
- source: an url to the source
- licenes: the license name
The configuration file may contain:
- name: The collection name (or the directory name if no one provided)
- pack: if true, it creates a file called
samples.jsonwith all the samples packed as base64 audio data (to fetch all the samples in one request)
The samples audio files should be named: inst-variation.ext where inst is the instrument name and variation is optional. For example: snare.wav, hihat-open.wav and hihat-closed.wav are valid names. Variations can be nested: hihat-open-h.wav
The letters m, l and h means mid, lower and higher. snare-l.wav it should be a lower snare than snare-m.wav and snare-ll.wav should be even lower.
You can use numbers padding by 2. snare-01.wav is valid, but snare-1.wav is not. Anyway, more descriptive variations are preferred: guiro-long.wav and guiro-short.wav vs. guiro-01.wav and guiro-02.wav
Try to name the sample with one of this names, if possible:
- snare
- rim (rimshot, sidesticks)
- hihat (variations:
hihat-open,hihat-closed) - kick
- tom
- crash
- cymball
- clap
- bongo
- conga
- tamb (tambourine)
- block
- cowbell
- timbal
- cabasa
- guiro
- clave
Each instrument has it's own license.