This is a template repository for modules for the Pragma Game Engine. If you want to create your own custom binary module, you can click on the Use this template button above to do so. For more detailed instructions, check out the wiki.
Once the repository has been generated, edit the values in template_pragma_module.json
:
- name: The name of the module as it will appear in the readme
- module_name: The internal name of the module (i.e. the name of the CMake target and the binaries). This name should always start with the prefix
pr_
and always be lowercase. - module_type: The type of the module, which can be "shared", "client" or "server".
- install_directory: The directory where the module should be installed to, relative to the Pragma installation. This should be somewhere in
modules/
oraddons/<addonName>/modules/
. - release_directory (optional): The directory that should be used for GitHub releases. If left empty, only the binary module itself will be added to the release. If your binary resides within an addon, specify the addon path here (
addons/<addonName>/
).
Once you have pushed the changes to this file, a GitHub workflow will be triggered, which will generate the final files (this may take a few minutes). This will also replace this readme with additional information and instructions.