ecsact config
To see the available config key options use:
- ecsact config --help
+ ecsact config --help
+ ecsact codegen
+ ecsact codegen subcommand allows you to generate code based
+ on your .ecsact files with
+ Ecsact codegen plugins.
+
Example usage:
+
+ # create ecsact_runtime shared library
+ ecsact codegen example.ecsact -p cpp_header
+
+ This will generate a file called example.ecsact.hh because it
+ utilised the built-in cpp_header plugin. You may also give
+ relative or absolute paths to the plugin flag (-p) for custom
+ plugins.
+
To see the available codegen options use:
+
+ ecsact codegen --help
+ ecsact build
+ ecsact build subcommand allows you to build an Ecsact
+ runtime implementation by
+ combining your .ecsact files and
+ build recipes (or
+ build recipe bundles). The result of running this subcommand is a shared library built for
+ your platform ready to be utilized by your game directly or your Ecsact
+ game engine integration.
+
Example usage:
+
+ # create ecsact_runtime shared library
+ ecsact build example.ecsact -r rt_entt -o ecsact_runtime
+
+ This will generate a file called
+ ecsact_runtime.dll (or ecsact_runtime.so on
+ Linux.) This is a shared library which utilises the
+
+ open_in_new rt_entt (Ecsact EnTT
+ runtime)
+ build recipe which implements several of the Ecsact
+ core module functions.
+ The runtime implementation is specifically tailored to be utilized with
+ the .ecsact files you passed to the subcommand. This allows
+ runtimes to be optimized specifically for your application.
+
+ Ecsact game engine integrations use ecsact build under the
+ hood and it is recommended to use ecsact build with your
+ build system when writing a custom solution.
+
To see the available build options use:
+
+ ecsact build --help
+ ecsact recipe-bundle
+ ecsact recipe-bundle subcommands allows you to create a
+ 'bundled recipe' which is usually used for distributing a build recipe.
+ Build recipes are YAML files that long lists of source files relative to
+ the recipes path. Using build recipe YAML files can be error-prone since
+ the developer has to make sure the other source files and codegen plugins
+ are installed in the correct location. Build recipe bundles solve this
+ issue by bundling the recipe YAML, source files, and codegen plugins all
+ into one file. This file can then be utilised with
+ ecsact build
+ directly.
+
Example usage:
+
+ # create example.ecsact-recipe-bundle
+ ecsact recipe-bundle example_recipe.yml -o example.ecsact-recipe-bundle
+ To see the available recipe bundle options use:
+
+ ecsact recipe-bundle --help
- More documentation on the CLI will be coming soon -