Skip to content

Add Instruments

Jump to bottom
redtide edited this page Feb 8, 2023 · 7 revisions

The homepage represents a list of sampled instruments categories, where each one is the visual representation of a file directory containing at least a category index page and, optionally, one or more local sampled instruments pages. All pages should be written in Markdown format (file extension .md) and the basic information of all categories and instruments must be written in a YAML database file.

Add a new category

When adding a new instrument list item and it should take part of a new category, a new file directory containing an index.md page file must be created. For example a category labeled Pianos on the homepage was created in /pianos/index.md file:

---
title:  "Pianos"
layout: "no_title"
---
{% include sfz/instruments_table.html %}

The category label and directory name must be set in the YAML database file, see the DB example below.

The title value can be arbitrary, it's just what will be displayed on the browser window title, usually same as the category label. The layout and include remains the same as the above example.

Add a new instrument

In order to add a SFZ instrument sample library to the site list, add the instrument information in the /_data/sfz/instruments.yml DB.

A new instrument page is optional, mainly used to display more information, add download links, images or audio demos. If not used will be used an external link:

screenshot

Also in this case see the DB example below.

Instrument page

If needed, create a new page inside a proper category subdirectory. For example, a /pianos/some_piano.md will be:

---
title:  "Some Piano"
layout: "sfz/instrument"
---
<!-- here will be inserted automatically the instrument brief description from the DB -->

Here goes only an optional, detailed instrument description content,
that will be appended to the brief description above. The empty line will be
added automatically as separator, no need to add one manually.

If an audio demo is available for the instrument, it must be made in mp3 format, placed in the /assets/audio directory with the same name and category as the page, so for the example described above it will be at /assets/audio/pianos/some_piano.mp3. A demo player will be added in the resulting HTML page.

To display an image it's a similar process, using a JPEG format: e.g.: /assets/img/pianos/some_piano.jpg.

The DB entries

Both instruments and related categories are added manually in alphabetic order. When specified, licenses must be in SPDX License ID format.

Example:

categories:
- name: ...

- name: "Pianos" # Category label, displayed in the homepage list
  page: "pianos" # used for the category directory name
  instruments:
  - name:    "Some piano" # page title, may be different from the one used in the browser title bar
    page:    "some_piano" # optional, page filename without extension when used
    version: "1.2"        # optional, if any version specified, 
    author:  "Some Author"
    license: "CC-BY-3.0"  # optional, if any license specified 
    url:     "https://some_author.com/some_piano"
    download_size: "6 GB" # total download size to display in the pianos list
    short_description:    # displayed in the category list and instrument page content
      "A great piano sample library in SFZ format."
    downloads:            # optional, for direct download links
    - label: "Instrument"
      url: "https://some_author.com/some_piano.zip"
      format: "wav"
      samplerate: "44.1"
      size: "5 GB"
      short_description: "Zipped file"

    - label: "Manual"
      url:   "https://some_author.com/some_piano_en.zip"
      size:  "1 GB"
      short_description: "English manual."
...

Clone this wiki locally