DevelopersPre-alpha

Manifests & depends

Explain manifest fields and how depends drives install order without Go imports between addons.

Manifest shape

Every addon root needs a manifest.json. Technical name must match the folder name. Generated zmodels.go registers models under that module.

addons/my_module/manifest.json

json

1{2  "name": "my_module",3  "display_name": "My Module",4  "version": "1.0.0",5  "author": "Your Company",6  "description": "Premium standard module for Sumeru ERP.",7  "depends": ["base"],8  "application": true,9  "data": [10    "security/security.xml",11    "security/sys.access.csv",12    "views/actions.xml",13    "views/form_view.xml",14    "views/list_view.xml",15    "views/kanban_view.xml",16    "views/menus.xml"17  ]18}

Fields that matter

Key	Meaning
`name`	Technical id (snake_case); install with `-i my_module`
`display_name`	UI label
`depends`	Install order; list technical names (usually includes `base`)
`application`	When true, appears as an installable app
`data`	Ordered list of XML/CSV files loaded on install/update

Depends without Go imports between addons

Module order comes from the manifest graph, not from importing another addon's Go package. Prefer depending on base (and other modules you need) and referencing XML ids with module.xml_id style refs.

Data load order

List security before views that assume groups exist. The sample order is: security XML -> access CSV -> actions -> views -> menus.

Compile and run

After editing the manifest data list:

Terminal

shell

$make generate$go run . -- -c sumeru.conf -u my_module --stop-after-init$make run

What not to do

Do not invent a depends entry for a module that is not on addons_path.
Do not reorder data so menus load before the actions they reference.
Do not change name without renaming the folder and re-registering models.

Next step

Define tables in Models & fields.