About Registry Dependencies

In Window > Project Settings you can specify your project file to be Type: Module (rather than Map). You can then add this Module to other Map or Mod files by adding them to the Dependencies list of another file. Here you can also add "Registry Dependencies" also known as "Registry Mods".

"Registry Dependencies" are essentially Module type projects that have been published to the server so that multiple projects can use them, and when the author publishes an update, projects using them will automatically update to the next version**.

To publish a registry module, set the project Type to Library (instead of Game) before publishing.

(**If the ^ character prefixes the version number, any sub-versions updates will be automatically applied, e.g. ^1.0.0 will auto update from 1.0.0 to 1.1.2. If a major version update occurs (1.0.0 > 2.0.0) this would require a manual update. This should only be done if there are compatability issues, meaning users have to modify their Lua to be compatible with the newer version. This way your project should never break from Registry Dependency auto-updates. The ^ character can be omitted to use a specific version. )

Any user can publish a registry mod, and registry mods can be viewed at https://module.wildsky.dev/module

However, there are several "First Party" Registry Dependencies, which are official mods created and maintained by the Funovus designer support team. These Mods are used by almost every project created in the Funovus editor, especially core which is added to every new map by default.

How to Use

After adding a registry mod to "Registry Dependencies" in your Project Settings, you have to require them in your Lua script to access their functions in your lua script:

local GMUI = require("GMUI")

Some of the first-party registry modules have their own wiki pages; however all first party mods have annotations, meaning once you include these in your project you can get a list of APIs and how to use them in VS Code by typing the module name:

It's helpful to understand that these are lua libraries implemented by fellow designers. The following are official first-party mods:

First-Party Registry Dependencies

These are the latest iteration of first-party registry dependencies, utilizing presentation scripting and newer case formatting. (GMUI vs the legacy gmui)

Core

Core is a general purpose layer just above DCEI API's, providing utility and shortcuts. Comes preinstalled on newer versions of the editor.

GMUI

GMUI is essential for creating custom game UI. Comes preinstalled on newer versions of the editor.

LegacyShop

LegacyShop handles selling in-game IAP micro-transactions and utilizes lazy loading. It's marked Legacy because it has not yet been updated to fully utilize presentation scripting.

Bank

Bank handles save/loading user save data between sessions.

Legacy Registry Dependencies

Legacy mods are prior to the addition of "presentation" layer scripting, and are used in older projects.

core
gmui
shop
lazy_shop
- lazy_shop is a shop branch which only creates UI elements as-needed. (e.g. lazy loading)
promo
meta (depreciated)
- meta was a mod for implementing meta features, like card collection.

Difference between latest mods (GMUI) and legacy mods (gmui)

Legacy mods are prior to the addition of "presentation" layer scripting, and are used in older projects. They use lower-case naming (gmui, core).

The latest iteration of first-party registry dependencies use proper case (GMUI, Core, Bank) utilizing presentation scripting. They're also broken up into more class files with some functions renamed, e.g. core.GetUnitFacingAngle(unit) is now Core.Unit.GetFacingAngle(unit).