Core DevPre-alpha

Manifests & depends

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

Standard directory layout

MODULE_STANDARD layout

<technical_name>/
  manifest.json
  init.go              # blank-import subpackages; optional event hooks
  hooks.go             # event.Subscribe, render hooks (optional)
  models/              # struct + sdk.Model; zmodels.go generated
  services/            # business logic (optional)
  views/               # XML menus, actions, views
  security/            # groups, rules, sys.access.csv
  data/                # seed/demo XML (optional)
  controllers/         # HTTP routes (optional)

Folder name must match manifest name (^[a-z][a-z0-9_]*$).

For a kernel reference layout see sumeru/addons/contacts/.

Manifest shape

manifest.json

json

1{2  "name": "engagement_cookbook",3  "display_name": "Engagements Cookbook",4  "version": "2.0.0",5  "depends": ["base", "contacts"],6  "application": true,7  "data": [8    "security/security.xml",9    "security/sys.access.csv",10    "views/actions.xml",11    "views/form_view.xml",12    "views/menus.xml"13  ]14}

Field	Purpose
`name`	Technical module name (directory name)
`depends`	Modules that must install first
`application`	`true` → shows as app tile on Home
`data`	XML/CSV load order on install/update

Bridge modules (e.g. sale_crm): "application": false, minimal data, logic in hooks.go / init.go.

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.

init.go vs hooks.go

In sumeru_addons, keep a hand-written init.go that blank-imports subpackages so init() runs.

In sumeru_custom_addons, workspace make generate overwrites each addon's init.go with a models-only blank import. Put event.Subscribe, render hooks, and cross-cutting logic in hooks.go at the addon root — see engagement_cookbook/hooks.go.

Data load order

List security before views that assume groups exist:

security/security.xml — groups
security/*_rules.xml — record rules (optional)
security/sys.access.csv — model ACLs
data/ — seed records
views/actions.xml — window actions
views/*_{form,list,kanban,...}_views.xml — base views before inherits
views/*_inherit_views.xml — xpath view inherits
views/menus.xml — always last

Compile and run

After editing the manifest data list:

$cd sumeru_custom_addons$make generate$make update MODULES=my_app

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.