optolith-database-schema v0.16.8

Optolith Database Schema

This repository contains all information and logic of the Optolith flat-file database, which itself is closed source due to licensing.

The repository consists of three parts: The user documentation, the JSON Schema documents and the TypeScript definitions, checks and other logic.

The entity reference in the documentation and the JSON Schema documents are generated using a self-written converter that walks the TypeScript AST and outputs them. This way, modification is only required and allowed in the TypeScript files, the other files must be generated.

Contribute

If you want to contribute, it is most likely you want to help with inserting new data into the database. In this case, the User Documentation is the place to start. Conversations usually happen on the Optolith Discord Server. We can also manage required permissions there, since you can't publicly access the database, as already mentioned.

If you want to contribute to the database schema itself, please open an issue or discussion (whatever fits best) with what you want to achieve so we can discuss it. Breaking changes would require changes inside the database as well, so Pull Requests are usually not the way to go unless you want to fix a bug.

Usage

If you want to use the database (or parts of it) in your own project (most likely to support Optolith export formats in your own application), you can use the TypeScript sources as a simple database reader, at least if you have a project targeting JavaScript interpreters as well. This way, you already have proper typings. You can extract the database from the installation folder of Optolith and then configure the database reader to your needs.