Development

Compendium Management

Management of Compendium files for Foundry v12+ requires a new approach due to changes in the database format to LevelDB. This is well documented on the Community Wiki.

The LDB files used by Foundry are a binary format optimised for runtime efficiency. Unfortunately, many of the file names and timestamps change on file access even when the content has not been updated, meaning that these files do not play nicely with Git. The workflow on this project uses the Foundry CLI tool to convert the LDB files to source-controlled YAML files, and GitHub workflow steps within the release building Action reverse the process, reconstructing the binary LDB files for inclusion into the module.zip release artifact.

Since the LDB files are not included in source control at all, that stage must be run manually before pushing content updates to GitHub.