These are the docs for 13.8, an old version of SpatialOS.
The docs for this version are frozen: we do not correct, update or republish them.
14.5 is the newest →
Building a schema descriptor
This page explains how to build a schema descriptor in a SpatialOS project that’s using the flexible project layout (FPL).
Schema descriptor introduction
The schema descriptor is a build artifact of a SpatialOS project assembly. It allows the SpatialOS Runtime to interpret your project’s schema and is necessary for starting a SpatialOS deployment both locally and in the cloud. You can generate a schema descriptor using the schema compiler tool.
Schema descriptor build process
- Download the schema compiler.
- Invoke the schema compiler as follows:
schema_compiler \
--schema_path=<my-schema-dir> \
--schema_path=<schema-std-lib-dir> \
--descriptor_set_out=<generated-output-dir> \
--load_all_schema_on_schema_path \
<my-schema-dir>/*.schema \
<schema-std-lib-dir>/*.schema
You can find an example of how to generate a schema descriptor here.