GamesModReadResult games.mod-read-result@1

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version
1.0.0
Owner
games
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/games/mod-read-result.v1.json

games.mod-read-result@1: answers of games.mod.read on OpenVibe.Games (public). GET /api/v1/mods → { mods } (every installed mod's public view: status and grants); GET /api/v1/mods/:id → one mod's public view with its installed manifest (mods.mod-manifest@1) and pack. An unknown id is 404 mod.not_found.

Fields

This schema has no named fields.

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: list
{
  "mods": [
    {
      "id": "mod_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "name": "Harbor Lights",
      "version": "1.2.0",
      "target": "games.browser",
      "runtime": "games-content@1",
      "trust_tier": "reviewed",
      "status": "enabled",
      "requested": [
        "games.prop.place",
        "games.world.announce"
      ],
      "granted": [
        "games.prop.place"
      ],
      "installed_at": "2026-09-20T10:00:00.000Z",
      "updated_at": "2026-09-25T18:00:00.000Z"
    }
  ]
}
Valid: one
{
  "id": "mod_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "name": "Harbor Lights",
  "version": "1.2.0",
  "target": "games.browser",
  "runtime": "games-content@1",
  "trust_tier": "reviewed",
  "status": "enabled",
  "requested": [
    "games.prop.place",
    "games.world.announce"
  ],
  "granted": [
    "games.prop.place"
  ],
  "installed_at": "2026-09-20T10:00:00.000Z",
  "updated_at": "2026-09-25T18:00:00.000Z",
  "manifest": {
    "id": "mod_01JABCDEFGHJKMNPQRSTVWXYZ0",
    "name": "Town Square",
    "version": "1.0.0",
    "description": "A public workbench and a greeting.",
    "publisher": {
      "type": "user",
      "id": "usr_01JABCDEFGHJKMNPQRSTVWXYZ0"
    },
    "target": "games.browser",
    "runtime": "games-content@1",
    "permissions": {
      "capabilities": [
        "games.world.announce",
        "games.prop.place"
      ]
    },
    "resources": {
      "cpuMs": 1,
      "memoryMb": 0,
      "storageMb": 0
    },
    "compatibility": {
      "runtime": ">=1.0.0 <2.0.0"
    }
  },
  "pack": {
    "announcements": [
      {
        "text": "Welcome to the town square.",
        "everySeconds": 900
      }
    ]
  }
}
Rejected: one-without-manifest
{
  "id": "mod_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "name": "Harbor Lights",
  "version": "1.2.0",
  "target": "games.browser",
  "runtime": "games-content@1",
  "trust_tier": "reviewed",
  "status": "enabled",
  "requested": [
    "games.prop.place",
    "games.world.announce"
  ],
  "granted": [
    "games.prop.place"
  ],
  "installed_at": "2026-09-20T10:00:00.000Z",
  "updated_at": "2026-09-25T18:00:00.000Z"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('games.mod-read-result@1', value);   // { valid, errors: [{ path, message }] }