Skip to content

Commit

Permalink
docs: sync latest json schema
Browse files Browse the repository at this point in the history
  • Loading branch information
mwfarb committed Sep 23, 2024
1 parent 3bf633a commit 774bf39
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 10 deletions.
7 changes: 4 additions & 3 deletions content/schemas/message/arena-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,13 @@ Program Attributes

|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|name|string||Name of the program in the format namespace/program-name.|Yes|
|name|string||Name of the program.|Yes|
|affinity|string; One of: ```['client', 'none']```|```'client'```|Indicates the module affinity (client=client's runtime; none or empty=any suitable/available runtime).|No|
|instantiate|string; One of: ```['single', 'client']```|```'client'```|Single instance of the program (=single), or let every client create a program instance (=client). Per client instance will create new uuid for each program.|Yes|
|filename|string||Filename of the entry binary.|Yes|
|file|string||The path to a `.wasm` file (e.g. `counter.wasm`, `user1/counter.wasm`) in the ARENA filestore, starting from the location field indicated below. See location. Example: user1/py/counter/counter.py should have file: `counter.py` and location: `user1/py/counter`. Note that the runtime will download all files in parent folder (e.g. you can add a requirements.txt)|Yes|
|location|string||Filestore path starting at user home; Example: `user1/hello` for a program inside folder `hello` of user1. Should, at least be the user filesore home folder.|Yes|
|filetype|string; One of: ```['WA', 'PY']```|```'WA'```|Type of the program (WA=WASM or PY=Python).|Yes|
|parent|string|```'pytest'```|Request the orchestrator to deploy to this runtime (can be a runtime name or UUID); usually left blank.|Yes|
|parent|string; Must be: ```arena-rt1```|```'arena-rt1'```|Request the orchestrator to deploy to this runtime (can be a runtime name or UUID); Temporarily must be arena-rt1.|Yes|
|args|array||Command-line arguments (passed in argv). Supports variables: ${scene}, ${mqtth}, ${cameraid}, ${username}, ${runtimeid}, ${moduleid}, ${query-string-key}.|No|
|env|array|```['MID=${moduleid}', 'SCENE=${scene}', 'NAMESPACE=${namespace}', 'MQTTH=${mqtth}', 'REALM=realm']```|Environment variables. Supports variables: ${scene}, ${namespace}, ${mqtth}, ${cameraid}, ${username}, ${runtimeid}, ${moduleid}, ${query-string-key}.|Yes|
|channels|array|```[{'path': '/ch/${scene}', 'type': 'pubsub', 'mode': 'rw', 'params': {'topic': 'realm/s/${scene}'}}]```|Channels describe files representing access to IO from pubsub and client sockets (possibly more in the future; currently only supported for WASM programs).|No|
Expand Down
7 changes: 4 additions & 3 deletions content/schemas/message/program.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ Program Data Attributes

|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|name|string||Name of the program in the format namespace/program-name.|Yes|
|name|string||Name of the program.|Yes|
|affinity|string; One of: ```['client', 'none']```|```'client'```|Indicates the module affinity (client=client's runtime; none or empty=any suitable/available runtime).|No|
|instantiate|string; One of: ```['single', 'client']```|```'client'```|Single instance of the program (=single), or let every client create a program instance (=client). Per client instance will create new uuid for each program.|Yes|
|filename|string||Filename of the entry binary.|Yes|
|file|string||The path to a `.wasm` file (e.g. `counter.wasm`, `user1/counter.wasm`) in the ARENA filestore, starting from the location field indicated below. See location. Example: user1/py/counter/counter.py should have file: `counter.py` and location: `user1/py/counter`. Note that the runtime will download all files in parent folder (e.g. you can add a requirements.txt)|Yes|
|location|string||Filestore path starting at user home; Example: `user1/hello` for a program inside folder `hello` of user1. Should, at least be the user filesore home folder.|Yes|
|filetype|string; One of: ```['WA', 'PY']```|```'WA'```|Type of the program (WA=WASM or PY=Python).|Yes|
|parent|string|```'pytest'```|Request the orchestrator to deploy to this runtime (can be a runtime name or UUID); usually left blank.|Yes|
|parent|string; Must be: ```arena-rt1```|```'arena-rt1'```|Request the orchestrator to deploy to this runtime (can be a runtime name or UUID); Temporarily must be arena-rt1.|Yes|
|args|array||Command-line arguments (passed in argv). Supports variables: ${scene}, ${mqtth}, ${cameraid}, ${username}, ${runtimeid}, ${moduleid}, ${query-string-key}.|No|
|env|array|```['MID=${moduleid}', 'SCENE=${scene}', 'NAMESPACE=${namespace}', 'MQTTH=${mqtth}', 'REALM=realm']```|Environment variables. Supports variables: ${scene}, ${namespace}, ${mqtth}, ${cameraid}, ${username}, ${runtimeid}, ${moduleid}, ${query-string-key}.|Yes|
|channels|array|```[{'path': '/ch/${scene}', 'type': 'pubsub', 'mode': 'rw', 'params': {'topic': 'realm/s/${scene}'}}]```|Channels describe files representing access to IO from pubsub and client sockets (possibly more in the future; currently only supported for WASM programs).|No|
Expand Down
8 changes: 4 additions & 4 deletions content/schemas/message/scene-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Scene Options Attributes

|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|clickableOnlyEvents|boolean|```True```|True = publish only mouse events for objects with click-listeners; False = all objects publish mouse events.|Yes|
|clickableOnlyEvents|boolean|```True```|True = publish only mouse events for objects with click-listeners; False = all objects publish mouse events.|No|
|distanceModel|string; One of: ```['exponential', 'inverse', 'linear']```|```'inverse'```|Algorithm to use to reduce the volume of the audio source as it moves away from the listener.|No|
|sceneHeadModels|array|```[]```|Define the default head model(s) for the scene in a list. Users may still choose from the ARENA default list of head models as well.|No|
|jitsiHost|string|```'jitsi0.andrew.cmu.edu:8443'```|Jitsi host used for this scene.|No|
Expand All @@ -30,9 +30,9 @@ Scene Options Attributes
|refDistance|number|```1```|Distance at which the volume reduction starts taking effect.|No|
|rolloffFactor|number|```1```|How quickly the volume is reduced as the source moves away from the listener.|No|
|screenshare|string|```'screenshare'```|Name of the 3D object used when sharing desktop.|No|
|videoFrustumCulling|boolean|```True```|If false, will disable video frustum culling (video frustum culling stops video from users outside of view).|Yes|
|videoDistanceConstraints|boolean|```True```|If false, will disable video distance constraints (video resolution decreases with distance from users in view).|Yes|
|videoDefaultResolutionConstraint|number|```180```|Sets the default max resolution for all users. Ignored when videoDistanceConstraints = true.|Yes|
|videoFrustumCulling|boolean|```True```|If false, will disable video frustum culling (video frustum culling stops video from users outside of view).|No|
|videoDistanceConstraints|boolean|```True```|If false, will disable video distance constraints (video resolution decreases with distance from users in view).|No|
|videoDefaultResolutionConstraint|number|```180```|Sets the default max resolution for all users. Ignored when videoDistanceConstraints = true.|No|
|volume|number|```1```|Volume for users in a scene.|No|
|physics|boolean|```False```|If true, will load the aframe-physics-system. Required for the following: `dynamic-body`, `impulse`, `collision-listener`.|Yes|
|ar-hit-test|object||A-Frame AR Hit Test Settings.
Expand Down

0 comments on commit 774bf39

Please sign in to comment.