Skip to content

Resources

A resource is a definition (fields, indexes, admin UI) plus rows. Resources are declared by modules and are module storage and admin data: module functions read and write them through the kernel API, and the dashboard and the admin API manage them. Game clients have no direct access to resource rows; they call the module’s client functions, usually through a generated module client.

Field types: string, number, bool, enum, datetime, duration, markdown, image, json, object, list, map, ref, reward, price, condition, value, ranges, segment, split, schedule.

Indexes such as ["score"] create a partial expression index on the field (numeric for number fields) for that resource.

List filters: _sort, _order, _start, _end, <field>_eq, <field>_in, <field>_like, _q.

REST (admin only):

  • /platform/v1/projects/{id}/resources for definitions
  • /platform/v1/projects/{id}/resources/{slug}/rows (dashboard) and /game/v1/resources/{slug}/rows (admin key) with batch mutations