README.md

_Lib

This mod offers additional API to simplify implementing certain features like configs and improve mod compatibility.

Current API:

• ApiApi
• Logger
• AccessorApi
• ComponentsApi
• HistoryApi
• InputMapApi
• LayerApi
• ModConfigApi
• ModSignalingApi
• PreferencesWindowApi
• Util

Using _Lib

To be able to access _Lib's Api put the following at the top of your mods start() method:

Engine.emit_signal("_lib_register_mod", self)

Alternatively check if the signal exists first to ensure _Lib is actually enabled:

if not Engine.has_signal("_lib_register_mod"):
    return
Engine.emit_signal("_lib_register_mod", self)

After registering your mod with _Lib you will now have an entry Global.API available that contains all of the _Lib APIs. For more info on how to use them check out the documentation.