crew-scores.md

Batukeitor docs

Crew scores

Each crew pack contains its own set of scores.

 demo/
├──  index.yml
└──  scores/
    ├──  samba-reggae.yml
    ├──  sample.yml
    └──  theory.yml

The scores folder

All Batukeitor YAML scores should be placed under this folder.

The name of the yml files must match the short names used in the scores section of the index.yml file.

# Batukeitor crew file
name: Demo crew
scores:
  sample: "Sample score"
  samba-reggae: "Samba Reggae"
  theory: "Basic Theory"

Add new scores

To create a new score:

• Add a score file inside the scores folder of the corresponding crew.

   demo/
  ├──  index.yml
  └──  scores/
    ├──  new-score.yml
    ├──  samba-reggae.yml
    ├──  sample.yml
    └──  theory.yml
  

• Update the corresponding crews/xxx/index.yml for the score to show in the interface combo.

  # Batukeitor crew file
  name: Demo crew
  scores:
    new-score: "My new score"
    sample: "Sample score"
    samba-reggae: "Samba Reggae"
    theory: "Basic Theory"

• Note that you can alter the ordering in which the scores are shown in the interface combo.

Add subfolders to organize scores

You can use subfolders if you accumulate a lot of scores, or you just want to keep them organized:

 demo/
├──  index.yml
└──  scores/
    ├──  2021
    │   └──  sample.yml
    ├──  2022
    │   └──  theory.yml
    └──  2023
        ├──  new-score.yml
        └──  samba-reggae.yml

# Batukeitor crew file
name: Demo crew
scores:
  2023/new-score: "My new score"
  2021/sample: "Sample score"
  2023/samba-reggae: "Samba Reggae"
  2022/theory: "Basic Theory"