Organizing Screens and Popups with Monarch

Prerequisite: Verify Monarch Dependency

Before applying any guidance from this skill, you MUST confirm that the project actually uses Monarch. Check the game.project file in the project root for a dependency URL containing britzl/monarch (e.g. dependencies#N = https://github.com/britzl/monarch/archive/...). Alternatively, check for the presence of a monarch/monarch.lua file in the project tree.

If neither a Monarch dependency in game.project nor a local monarch/monarch.lua module is found, do NOT apply this skill. Inform the user that the project does not appear to use Monarch and suggest adding the dependency to game.project if they want to use it:

[project]
dependencies#N = https://github.com/britzl/monarch/archive/refs/tags/5.2.0.zip

This skill describes the conventions for creating and managing screens (via collectionproxy) and popups (via collectionfactory) in a Defold project using the Monarch library.

Naming Rules