🏷️ Nomenclature & Conventions#

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

Files	Use the snake_case convention. A few names are reserved for special functions at the root of each module: `__help__`, `__load__`, and `__unload__` Example: `function/<my_function>.mcfunction`
Entity tags	Use the snake_case convention. Must be prefixed with `bs.` and the name of the module Example: `bs.<module>.my_tag`
Data storage	Use the snake_case convention. Is limited to what is defined in the Shared Resources section Example: `bs:data <module>.<feature>`
Objectives	Use the snake_case convention and `bs.` prefix. Only create new objectives if no existing objective defined in the Shared Resources section can be used Example: `bs.my_objective`
Scoreholders	Use the snake_case convention. Must be prefixed with the name of the module. Each score should also be prefixed by either `#` for private scores or `$` for public ones Example: `$<module>.debug` or `#<module>.any`

Moreover, Bookshelf follows Smithed’s conventions, especially for the entity tags. Here are the entity tags used in Bookshelf:

smithed.entity	Used to identify entities that are created by datapacks and that should not be modified by datapacks targeting vanilla entities
smithed.strict	Used to identify entities that are created by datapacks and that should not be modified by other datapacks
bs.persistent	Used to identify Bookshelf entities that are persistent and should not be despawned/killed
bs.entity	Used to identify entities that are created by Bookshelf