Synchrony modding API documentation

Welcome to Synchrony's Lua modding API. The documentation (and, to some extent, the API itself) is still heavily work-in-progress and will undergo frequent changes. In particular, descriptions for modules, methods, parameters, events, components and fields are currently missing. These will be added over time, prioritizing important modules for gameplay modding.

As a result, there is currently only limited support for the Lua API! Until Synchrony's gameplay features are finalized and version 1.0 is released, any functions or components that appear in this API documentation may be changed or removed at any time.

However, we'd still like to encourage early experimentation and feedback with the modding API. Feel free to look at the #mod-showcase channel on the Synchrony Discord server for some example mods with source code!

generated by LDoc 1.4.6