🏷️Nomenclature

Bookshelf respects certain naming conventions in order to reduce the effort needed to read and understand code.

• Storage use the snake_case convention and is limited to the one defined in the shared data section.

  Example: bs:data <module>.<feature>

• Objectives use the snake_case convention with a bs. prefix.

  Example: bs.<module>.my_objective

• Tags use the snake_case convention with an indication of the path to the module as prefix.

  Example: bs.<module>.my_tag

• Fake players use the snake_case convention with an indication of the path to the module as prefix. Each score should be prefixed by either # for temporary scores or $ for important ones. Prefixing the score with bs. is not needed there.

  Exemple: $<module>.debug or #<module>.any.

• Functions use the snake_case convention. A few names are reserved for special functions at the root of each module: __help__, __load__, __tick__, and __unload__.