OpenVibe.Games API
Generated at from
openvibe-contracts v0.53.0 and
openvibe-sdk v0.11.0.
Server https://openvibe.games. 9 routes performing 4 capabilities. OpenAPI 3.1 document.
GET /api/v1/mods
Read the browser game's installed mods: manifest, content pack, status, trust tier, requested and granted capabilities.
- Capabilities
- games.mod.read
- Visibility
- public
- Response
application/jsongames.mod-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>games.mod.read</strong> (public): Read the browser game's installed mods: manifest, content pack, status, trust tier, requested and granted capabilities. Public; no token needed.</p>POST /api/v1/mods
Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, di
- Capabilities
- games.mod.manage
- Visibility
- first-party
- Request body
application/jsongames.mod-manage-request@1- Response
application/jsongames.mod-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>games.mod.manage</strong> (first-party): Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, disable, and revoke an install for good (its effects end on the next server tick). Every action is audited and published as a games.mod.* event. Trust tiers are metadata and never grant anything. Also accepted from an openvibe.network owner/admin session.</p>GET /api/v1/mods/{id}
Read the browser game's installed mods: manifest, content pack, status, trust tier, requested and granted capabilities.
- Capabilities
- games.mod.read
- Visibility
- public
- Parameters
id(path, required)
- Response
application/jsongames.mod-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>games.mod.read</strong> (public): Read the browser game's installed mods: manifest, content pack, status, trust tier, requested and granted capabilities. Public; no token needed.</p>GET /api/v1/mods/{id}/audit
Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, di
- Capabilities
- games.mod.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Input
- games.mod-manage-request@1
- Response
application/jsongames.mod-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>games.mod.manage</strong> (first-party): Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, disable, and revoke an install for good (its effects end on the next server tick). Every action is audited and published as a games.mod.* event. Trust tiers are metadata and never grant anything. Also accepted from an openvibe.network owner/admin session.</p>POST /api/v1/mods/{id}/disable
Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, di
- Capabilities
- games.mod.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsongames.mod-manage-request@1- Response
application/jsongames.mod-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>games.mod.manage</strong> (first-party): Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, disable, and revoke an install for good (its effects end on the next server tick). Every action is audited and published as a games.mod.* event. Trust tiers are metadata and never grant anything. Also accepted from an openvibe.network owner/admin session.</p>POST /api/v1/mods/{id}/enable
Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, di
- Capabilities
- games.mod.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsongames.mod-manage-request@1- Response
application/jsongames.mod-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>games.mod.manage</strong> (first-party): Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, disable, and revoke an install for good (its effects end on the next server tick). Every action is audited and published as a games.mod.* event. Trust tiers are metadata and never grant anything. Also accepted from an openvibe.network owner/admin session.</p>POST /api/v1/mods/{id}/grants
Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, di
- Capabilities
- games.mod.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsongames.mod-manage-request@1- Response
application/jsongames.mod-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>games.mod.manage</strong> (first-party): Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, disable, and revoke an install for good (its effects end on the next server tick). Every action is audited and published as a games.mod.* event. Trust tiers are metadata and never grant anything. Also accepted from an openvibe.network owner/admin session.</p>DELETE /api/v1/mods/{id}/grants/{capability}
Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, di
- Capabilities
- games.mod.manage
- Visibility
- first-party
- Parameters
id(path, required)capability(path, required)
- Input
- games.mod-manage-request@1
- Response
application/jsongames.mod-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>games.mod.manage</strong> (first-party): Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, disable, and revoke an install for good (its effects end on the next server tick). Every action is audited and published as a games.mod.* event. Trust tiers are metadata and never grant anything. Also accepted from an openvibe.network owner/admin session.</p>POST /api/v1/mods/{id}/revoke
Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, di
- Capabilities
- games.mod.manage
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsongames.mod-manage-request@1- Response
application/jsongames.mod-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>games.mod.manage</strong> (first-party): Manage mod installs in the browser game's registry (ADR-013): install a mods/mod-manifest.v1 manifest with its games-content@1 pack, approve or revoke individual capabilities of an install, enable, disable, and revoke an install for good (its effects end on the next server tick). Every action is audited and published as a games.mod.* event. Trust tiers are metadata and never grant anything. Also accepted from an openvibe.network owner/admin session.</p>Other bindings
- games.prop.place:
mod runtime binding ModApi.placeProp / ModApi.removeProp (apps/server/src/mods/runtime.ts) - games.world.announce:
mod runtime binding ModApi.announce (apps/server/src/mods/runtime.ts)