Liaison studio-core
The WebSocket connection between Studio (UI and Studio host) and the Core.
Opérations
| Nom | Sens | Message | Réponse | Erreurs possibles | Sujet | Description |
|---|---|---|---|---|---|---|
| renderStart | le Core reçoit | RenderStart (render/start) | RenderStatus (render/status) | render-running, render-unavailable, invalid-payload | — | The Core launches sequa-render with the requested adapter and replies as soon as the process is launched (state "starting"). Studio then follows the switch to "running" through render/changed events, or by polling render/status. |
| renderStatusRequest | le Core reçoit | RenderStatusRequest (render/status) | RenderStatus (render/status) | — | — | The Core replies with the render state (RenderStatus). If the renderer is not running, the Core replies with a RenderStatus in state "stopped". This request never fails. |
| hello | le Core reçoit | Hello (hello) | Welcome (welcome) | incompatible-protocol, invalid-payload | — | First message of the connection, from Studio (client sequa-studio) or Studio host (client sequa-studio-host). Any other first message: Error handshake-required, then close (1008). Incompatible version: Error incompatible-protocol, then close (1008). Rejected hello: Error invalid-payload, then close (1002). |
| corePing | le Core reçoit | CorePing (core/ping) | CorePong (core/ping) | — | — | |
| coreStatusRequest | le Core reçoit | CoreStatusRequest (core/status) | CoreStatus (core/status) | — | — | |
| coreAttach | le Core reçoit | CoreAttach (core/attach) | LinkStatus (core/attach) | controller-exists | — | The connection becomes the controller and the lease is put in force. If another controller is connected: Error controller-exists, unless force (the former one loses the role). Lease rules: spec 0.4 §5. |
| coreDetach | le Core reçoit | CoreDetach (core/detach) | LinkStatus (core/attach) | not-controller | — | Controller only. The Core goes on without a controller. |
| coreShutdown | le Core reçoit | CoreShutdown (core/shutdown) | ShutdownAccepted (core/shutdown) | — | — | The reply is sent, then the Core stops cleanly (exit code 0) in less than 2 s. |
| sessionStart | le Core reçoit | SessionStart (session/start) | SessionStatus (session/status) | — | — | Replaces the current session: tick 0, running. |
| sessionPause | le Core reçoit | SessionPause (session/pause) | SessionStatus (session/status) | — | — | |
| sessionResume | le Core reçoit | SessionResume (session/resume) | SessionStatus (session/status) | — | — | |
| sessionStatusRequest | le Core reçoit | SessionStatusRequest (session/status) | SessionStatus (session/status) | — | — | |
| sessionInput | le Core reçoit | SessionInput (session/input) | InputAccepted (session/input) | — | — | Applies to the next executed tick; the last input before that tick wins; it stays active until the next one. Recorded with its tick: the replay is exact. |
| sessionExport | le Core reçoit | SessionExport (session/export) | SessionExported (session/export) | — | — | |
| sessionImport | le Core reçoit | SessionImport (session/import) | SessionImported (session/import) | invalid-recording | — | Replays every recorded tick as fast as possible, with the current settings of the Core, then the session goes on from there (resume chooses running or paused). Rejected recording: Error invalid-recording, the current session is kept. |
| renderStop | le Core reçoit | RenderStop (render/stop) | RenderStatus (render/status) | — | — | Replies with the render state (stopped). Never fails, even if the renderer is already stopped. |
| eventsSubscribe | le Core reçoit | EventsSubscribe (events/subscribe) | Subscriptions (events/subscribe) | — | — | Replies with the topics followed after the request. The first event of a topic may arrive before this reply. Subscriptions disappear with the connection. |
| eventsUnsubscribe | le Core reçoit | EventsUnsubscribe (events/unsubscribe) | Subscriptions (events/subscribe) | — | — | Unsubscribing from a topic that is not followed is not an error. |
| logProtocolRequest | le Core reçoit | LogProtocolRequest (log/protocol) | LogProtocolStatus (log/protocol) | invalid-payload | — | The protocol log is off by default because it is heavy (sequa-core --protocol-log still works). Studio can turn it on, change its level (summary, full) or turn it off (off), while the Core is running. Any authorized connection may send it. The Core replies with the resulting state. |
| fsList | le Core reçoit | FsList (fs/list) | FsListing (fs/listing) | path-not-found, path-denied, io-failure, invalid-payload | — | Used by the "New project" window to browse the Core's machine. Read only: the Core lists folders, never files. Folders the system refuses to open are listed but give path-denied when listed themselves. |
| fsMakeDir | le Core reçoit | FsMakeDir (fs/mkdir) | FsListing (fs/listing) | path-not-found, path-denied, already-exists, invalid-name, io-failure, invalid-payload | — | The only write outside a project folder asked by Studio, always explicitly by the user ("New folder" in the "New project" window). The Core also keeps the recent projects in the user's settings folder (project/recent). |
| projectCreate | le Core reçoit | ProjectCreate (project/create) | ProjectStatus (project/status) | path-not-found, path-denied, already-exists, invalid-name, io-failure, invalid-payload | — | The Core creates <parent>/<folder>/ (or uses it if it exists and is empty), writes the project files (ADR 0015) and the asset catalog (ADR 0016), then opens the project, which replaces the open one. On failure, what was created is removed and the open project is kept. On success, the project is added to the recent projects and project/changed is sent to the subscribers of the "project" topic. |
| projectStatusRequest | le Core reçoit | ProjectStatusRequest (project/status) | ProjectStatus (project/status) | — | — | Replies with the open project, or with an empty ProjectStatus when no project is open. This request never fails. |
| projectOpen | le Core reçoit | ProjectOpen (project/open) | ProjectStatus (project/status) | path-not-found, path-denied, not-a-project, invalid-project, newer-project, io-failure, invalid-payload | — | The Core reads and checks the project files (ADR 0015), prepares the asset catalog (ADR 0016), then opens the project, which replaces the open one. Nothing is written in the project files themselves; only the local folder .sequa/ may change (catalog rebuilt, damaged base set aside in .sequa/backups/). On failure, the open project is kept. On success, the project is added to the recent projects and project/changed is sent to the subscribers of the "project" topic. Opening the open project again reads it again. |
| projectClose | le Core reçoit | ProjectClose (project/close) | ProjectStatus (project/status) | — | — | Replies with an empty ProjectStatus. This request never fails. When a project was open, project/changed is sent to the subscribers of the "project" topic. |
| projectRecentRequest | le Core reçoit | ProjectRecentRequest (project/recent) | ProjectRecent (project/recent) | — | — | Projects created or opened on the Core's machine, most recent first. The Core checks that each .sequa file still exists (missing). An unreadable list reads as empty. This request never fails. |
| projectChanged | le Core envoie | ProjectChanged (project/changed) | — | — | project | Sent only to connections subscribed to the "project" topic (events/subscribe). The first event is sent right after the subscription (initial state, empty when no project is open). Then an event follows every successful project/create, project/open, project/close of an open project, and space/* request except space/thumbnail-get, whichever connection sent it. The first event may arrive before the reply to events/subscribe. An event never replaces a reply. |
| spaceCreate | le Core reçoit | SpaceCreate (space/create) | ProjectStatus (project/status) | no-project, invalid-name, invalid-payload, io-failure | — | The Core creates spaces/<folder>/space.json and adds the Space to the .sequa file. The new Space is Active, neither Default nor Selected. Replies with the open project, then project/changed is sent to the subscribers of the "project" topic. |
| spaceUpdate | le Core reçoit | SpaceUpdate (space/update) | ProjectStatus (project/status) | no-project, space-not-found, space-read-only, invalid-name, invalid-payload, io-failure | — | Name, description, tags and version replace the former values in space.json. When the name changes, the folder of the Space is renamed after it, like at creation (folder made unique by a suffix), then its path is rewritten in the .sequa file; if that writing fails, the folder gets its former name back. A Space is always referred to by its id, never by its folder. A folder held by another program cannot be renamed (io-failure, nothing changed). Replies with the open project, then project/changed. |
| spaceDelete | le Core reçoit | SpaceDelete (space/delete) | ProjectStatus (project/status) | no-project, space-not-found, space-read-only, default-space, io-failure | — | The folder of the Space is moved to .sequa/trash/<date>/spaces/<folder>/ and the Space removed from the .sequa file. When it was Selected, the selection goes back to the Default Space. Replies with the open project, then project/changed. |
| spaceSelect | le Core reçoit | SpaceSelect (space/select) | ProjectStatus (project/status) | no-project, space-not-found, io-failure | — | Allowed for a read-only Space. The selection is kept in .sequa/workspace.json (local, ignored by git). Replies with the open project, then project/changed. |
| spaceSetDefault | le Core reçoit | SpaceSetDefault (space/set-default) | ProjectStatus (project/status) | no-project, space-not-found, io-failure | — | Allowed for a read-only Space. Written in the .sequa file (defaultSpace). Replies with the open project, then project/changed. |
| spaceSetActive | le Core reçoit | SpaceSetActive (space/set-active) | ProjectStatus (project/status) | no-project, space-not-found, io-failure | — | Written in the space.json of the Space (active). Allowed for a read-only Space: it is the way back to editing. Replies with the open project, then project/changed. |
| spaceThumbnailSet | le Core reçoit | SpaceThumbnailSet (space/thumbnail-set) | ProjectStatus (project/status) | no-project, space-not-found, space-read-only, invalid-image, invalid-payload, io-failure | — | The Core checks the image (type and first bytes), writes spaces/<folder>/SpaceThumb.<ext> and removes any other SpaceThumb.* file. Absent data removes the thumbnail. Replies with the open project (new thumbnailHash), then project/changed. |
| spaceThumbnailGet | le Core reçoit | SpaceThumbnailGet (space/thumbnail-get) | SpaceThumbnail (space/thumbnail) | no-project, space-not-found, io-failure | — | Replies with the image, or without data when the Space has no thumbnail. When several SpaceThumb.* files exist (copied by hand), the Core keeps the most recent and removes the others. Nothing is sent to the subscribers. |
| renderChanged | le Core envoie | RenderChanged (render/changed) | — | — | render | Sent only to connections subscribed to the "render" topic (events/subscribe). The first event is sent right after the subscription (initial state). Then an event is sent at most 50 ms after a change; two consecutive events never carry the same state. While the renderer is running, the measurements trigger an event about every second. worldVersion alone does not trigger an event. The first event may arrive before the reply to events/subscribe. An event never replaces a reply. |
Messages
| Numéro | Nom | Type dans le protocole | Table du contenu |
|---|---|---|---|
| 1 | Error | error | Error |
| 2 | RenderStart | render/start | RenderStart |
| 3 | RenderStatus | render/status | RenderStatus |
| 4 | RenderStatusRequest | render/status | RenderStatusRequest |
| 5 | RenderChanged | render/changed | RenderStatus |
| 6 | LogProtocolRequest | log/protocol | LogProtocol |
| 7 | LogProtocolStatus | log/protocol | LogProtocolStatus |
| 8 | Hello | hello | Hello |
| 9 | Welcome | welcome | Welcome |
| 10 | CorePing | core/ping | CorePing |
| 11 | CorePong | core/ping | CorePong |
| 12 | CoreStatusRequest | core/status | CoreStatusRequest |
| 13 | CoreStatus | core/status | CoreStatus |
| 14 | CoreAttach | core/attach | CoreAttach |
| 15 | LinkStatus | core/attach | LinkStatus |
| 16 | CoreDetach | core/detach | CoreDetach |
| 17 | CoreShutdown | core/shutdown | CoreShutdown |
| 18 | ShutdownAccepted | core/shutdown | ShutdownAccepted |
| 19 | SessionStart | session/start | SessionStart |
| 20 | SessionStatus | session/status | SessionStatus |
| 21 | SessionPause | session/pause | SessionPause |
| 22 | SessionResume | session/resume | SessionResume |
| 23 | SessionStatusRequest | session/status | SessionStatusRequest |
| 24 | SessionInput | session/input | SessionInput |
| 25 | InputAccepted | session/input | InputAccepted |
| 26 | SessionExport | session/export | SessionExport |
| 27 | SessionExported | session/export | SessionExported |
| 28 | SessionImport | session/import | SessionImport |
| 29 | SessionImported | session/import | SessionImported |
| 30 | RenderStop | render/stop | RenderStop |
| 31 | EventsSubscribe | events/subscribe | EventTopics |
| 32 | EventsUnsubscribe | events/unsubscribe | EventTopics |
| 33 | Subscriptions | events/subscribe | Subscriptions |
| 34 | FsList | fs/list | FsList |
| 35 | FsMakeDir | fs/mkdir | FsMakeDir |
| 36 | FsListing | fs/listing | FsListing |
| 37 | ProjectCreate | project/create | ProjectCreate |
| 38 | ProjectStatusRequest | project/status | ProjectStatusRequest |
| 39 | ProjectStatus | project/status | ProjectStatus |
| 40 | ProjectOpen | project/open | ProjectOpen |
| 41 | ProjectClose | project/close | ProjectClose |
| 42 | ProjectRecentRequest | project/recent | ProjectRecentRequest |
| 43 | ProjectRecent | project/recent | ProjectRecent |
| 44 | ProjectChanged | project/changed | ProjectStatus |
| 45 | SpaceCreate | space/create | SpaceCreate |
| 46 | SpaceUpdate | space/update | SpaceUpdate |
| 47 | SpaceDelete | space/delete | SpaceDelete |
| 48 | SpaceSelect | space/select | SpaceSelect |
| 49 | SpaceSetDefault | space/set-default | SpaceSetDefault |
| 50 | SpaceSetActive | space/set-active | SpaceSetActive |
| 51 | SpaceThumbnailSet | space/thumbnail-set | SpaceThumbnailSet |
| 52 | SpaceThumbnailGet | space/thumbnail-get | SpaceThumbnailGet |
| 53 | SpaceThumbnail | space/thumbnail | SpaceThumbnail |
Liaison core-render
The WebSocket connection between sequa-render and the Core.
Opérations
| Nom | Sens | Message | Réponse | Erreurs possibles | Sujet | Description |
|---|---|---|---|---|---|---|
| sceneDelta | le Core envoie | SceneDelta (scene/delta) | — | — | — | The first delta after render/ready is a complete scene (full: true). Then the Core sends a delta after each tick that changes the scene; a tick without change sends nothing. The renderer queues the deltas received and applies all of them, in order, before each frame; none is skipped, even when the renderer falls behind. Applying a delta that fails (version going back, unknown id) is a protocol error: the renderer sends render/failed with the code "invalid-delta" and exits. |
| renderHello | le Core reçoit | Hello (hello) | RenderWelcome (welcome) | incompatible-protocol, invalid-payload, render-exists | — | First message of sequa-render (client sequa-render). A second renderer: Error render-exists, then close (1008). Same version and handshake rules as the studio-core link. After welcome, the renderer sends render/ready, then the Core sends a complete scene (scene/delta with full: true). |
| renderReady | le Core reçoit | RenderReady (render/ready) | — | — | — | Sent once, after the adapter started. The Core waits for it 20 s at most. |
| renderFailed | le Core reçoit | RenderFailed (render/failed) | — | — | — | The renderer then closes the connection and exits with code 1; the Core restarts it (at most 3 times a minute) and shows the failure in lastFailure. |
| renderClosed | le Core reçoit | RenderClosed (render/closed) | — | — | — | The renderer exits with code 4; it is not restarted (state stopped). |
| renderInput | le Core reçoit | RenderInput (render/input) | — | — | — | Applied like session/input (next tick, held, the last one wins, recorded). When the renderer disconnects with a non-neutral input, the Core resets the input to neutral. Rejected: Error invalid-payload, input unchanged, connection kept. |
| stopRender | le Core envoie | StopRender (render/stop) | — | — | — | The renderer stops the adapter and exits with code 0. The Core waits 3 s, then terminates the process. |
| renderFrames | le Core reçoit | RenderFrames (render/frames) | — | — | — | Sent by sequa-render about every second, without reply. The Core keeps the last one and shows it in render/status and render/changed (measurements). A rejected render/frames gets an Error; the connection is kept. |
Messages
| Numéro | Nom | Type dans le protocole | Table du contenu |
|---|---|---|---|
| 1 | Error | error | Error |
| 2 | SceneDelta | scene/delta | SceneDelta |
| 3 | RenderFrames | render/frames | RenderFrames |
| 4 | RenderWelcome | welcome | Welcome |
| 5 | RenderReady | render/ready | RenderReady |
| 6 | RenderFailed | render/failed | RenderFailed |
| 7 | RenderClosed | render/closed | RenderClosed |
| 8 | Hello | hello | Hello |
| 9 | RenderInput | render/input | RenderInput |
| 10 | StopRender | render/stop | RenderStop |
Types — common/errors.yaml
Espace de noms sequa.common
ErrorCode énumération
Error codes of the Studio <-> Core and Core <-> render links.
| Valeur | Numéro | Description |
|---|---|---|
invalid-message | 0 | |
unknown-type | 1 | |
invalid-payload | 2 | |
render-running | 3 | |
render-unavailable | 4 | |
handshake-required | 5 | |
incompatible-protocol | 6 | |
unauthorized | 7 | |
forbidden-origin | 8 | |
controller-exists | 9 | |
not-controller | 10 | |
invalid-recording | 11 | |
render-exists | 12 | |
path-not-found | 13 | |
path-denied | 14 | |
already-exists | 15 | |
invalid-name | 16 | |
io-failure | 17 | |
not-a-project | 18 | |
invalid-project | 19 | |
newer-project | 20 | |
no-project | 21 | |
space-not-found | 22 | |
space-read-only | 23 | |
default-space | 24 | |
invalid-image | 25 |
Error table
Rejection of a request, or connection error.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | code | ErrorCode | obligatoire | — | ||
| 1 | message | string | facultatif | maxLength 1000 | Human-readable explanation, in English (logs, debugging). |
Types — common/geometry.yaml
Espace de noms sequa.common
Vec3 struct
3D vector (position, size, scale).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | x | float32 | obligatoire | — | ||
| 1 | y | float32 | obligatoire | — | ||
| 2 | z | float32 | obligatoire | — |
Quat struct
Unit quaternion (x, y, z, w).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | x | float32 | obligatoire | — | ||
| 1 | y | float32 | obligatoire | — | ||
| 2 | z | float32 | obligatoire | — | ||
| 3 | w | float32 | obligatoire | — |
Color struct
Linear color (not sRGB), components between 0 and 1.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | r | float32 | obligatoire | — | ||
| 1 | g | float32 | obligatoire | — | ||
| 2 | b | float32 | obligatoire | — | ||
| 3 | a | float32 | obligatoire | — |
Transform struct
Position, rotation and scale of an object.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | position | Vec3 | obligatoire | — | ||
| 1 | rotation | Quat | obligatoire | — | ||
| 2 | scale | Vec3 | obligatoire | — |
Types — common/handshake.yaml
Espace de noms sequa.common
Client énumération
The program that opens the connection.
| Valeur | Numéro | Description |
|---|---|---|
sequa-studio | 0 | |
sequa-studio-host | 1 | |
sequa-render | 2 |
Hello table
First message of a connection. The link is given by the file identifier of the frame
(SQSC: studio-core, SQCR: core-render); client must belong to that link.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | protocolVersion | string | obligatoire | minLength 5, maxLength 32 | Contract version of the sender (major.minor.patch, optionally followed by -... or +...). Compatible: same major and, while the major is 0, same minor. | |
| 1 | client | Client | obligatoire | — |
Types — common/measurements.yaml
Espace de noms sequa.common
RenderMeasurements table
Render measurements over the last second.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | framesPerSecond | uint32 | obligatoire | — | Frames rendered during the last second. | |
| 1 | cpuMsMedian | float32 | obligatoire | — | Median CPU time per frame, in milliseconds. | |
| 2 | cpuMsP95 | float32 | obligatoire | — | 95th percentile CPU time per frame, in milliseconds. | |
| 3 | latencyUsMedian | float32 | obligatoire | — | Median transport latency, in microseconds (end of tick -> delta received by the renderer). | |
| 4 | latencyUsP95 | float32 | obligatoire | — | 95th percentile transport latency, in microseconds (end of tick -> delta received by the renderer). | |
| 5 | applyUsMedian | float32 | obligatoire | — | Median apply time, in microseconds (end of tick -> delta applied, frame wait included). | |
| 6 | applyUsP95 | float32 | obligatoire | — | 95th percentile apply time, in microseconds (end of tick -> delta applied, frame wait included). | |
| 7 | gpuMsMedian | float32 | facultatif | — | Median GPU time per frame, in milliseconds. Absent if the engine does not measure the GPU. | |
| 8 | gpuMsP95 | float32 | facultatif | — | 95th percentile GPU time per frame, in milliseconds. Absent if the engine does not measure the GPU. | |
| 9 | vramBytes | uint64 | facultatif | — | Video memory used by the engine at the end of the second, in bytes. Absent if the engine does not measure it. |
Types — common/recording.yaml
Espace de noms sequa.common
InputFrame struct
A non-neutral player input and the tick it applies to.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | tick | uint64 | obligatoire | — | ||
| 1 | buttons | uint32 | obligatoire | — | Pressed actions, one bit each. | |
| 2 | moveX | int16 | obligatoire | — | ||
| 3 | moveY | int16 | obligatoire | — |
Recording table
Recording of a session. Also checked after reading: tick rate not zero, inputs in
strictly increasing tick order, each before tickCount and not neutral; otherwise
invalid-recording.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | seed | uint64 | obligatoire | — | ||
| 1 | tickRateHz | uint32 | obligatoire | minimum 1, maximum 10000 | Fixed simulation rate, in ticks per second. | |
| 2 | tickCount | uint64 | obligatoire | — | Ticks executed since the start of the session. | |
| 3 | inputs | [InputFrame] | obligatoire | maxItems 10000000 | Non-neutral inputs, in increasing tick order (about 46 hours of play at 60 Hz at most). |
Types — core-render/handshake.yaml
Espace de noms sequa.core_render
Welcome table
Reply of the Core to hello on the core-render link.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | protocolVersion | string | obligatoire | maxLength 32 | Contract version of the Core. | |
| 1 | coreVersion | string | obligatoire | maxLength 64 | ||
| 2 | instanceId | string | obligatoire | minLength 32, maxLength 32 | Identifies this run of the Core (32 hexadecimal characters). | |
| 3 | renderId | string | obligatoire | minLength 32, maxLength 32 | Identifies this launch of the renderer (32 hexadecimal characters). |
Types — core-render/render.yaml
Espace de noms sequa.core_render
RenderFrames table
Render measurements of the last second, sent by sequa-render about every second.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | lastWorldVersion | uint64 | obligatoire | — | Scene version shown by the last frame. | |
| 1 | measurements | RenderMeasurements | obligatoire | — |
RenderCapabilities table
Capabilities of the engine loaded by the adapter.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | engineName | string | obligatoire | minLength 1, maxLength 64 | Engine name (godot, debug). | |
| 1 | engineVersion | string | obligatoire | maxLength 64 | Engine version actually used (4.7.2-stable). | |
| 2 | buffers | [string] | obligatoire | maxItems 16 | Frame buffers produced (color, depth, normals, motion_vectors, albedo, object_ids, semantic_mask). | |
| 3 | windowed | bool | obligatoire | — | The engine has its own game window. | |
| 4 | headless | bool | obligatoire | — | Off-screen rendering. | |
| 5 | playerInput | bool | obligatoire | — | The engine captures player input (ADR 0011). |
RenderReady table
The adapter started; sent once, right after welcome.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | capabilities | RenderCapabilities | obligatoire | — | ||
| 1 | width | uint16 | obligatoire | minimum 1 | Frame width, in pixels. | |
| 2 | height | uint16 | obligatoire | minimum 1 | Frame height, in pixels. |
RenderFailure énumération
Why the renderer stops.
| Valeur | Numéro | Description |
|---|---|---|
adapter-load | 0 | |
adapter-start | 1 | |
invalid-delta | 2 | |
render-frame | 3 | |
invalid-message | 4 |
RenderFailed table
The renderer failed; it closes the connection and exits with code 1.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | code | RenderFailure | obligatoire | — | ||
| 1 | message | string | facultatif | maxLength 1000 | Human-readable explanation (logs, lastFailure of the render state). |
RenderClosed table
The user closed the window; the renderer exits with code 4 and is not restarted (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
RenderStop table
Stop the adapter and exit with code 0 (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
RenderInput table
Player input already translated into actions by the adapter (ADR 0011). Sent only when
the actions change. Applied by the Core like session/input; it is recorded.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | buttons | uint32 | obligatoire | — | Pressed actions, one bit each. | |
| 1 | moveX | int16 | obligatoire | minimum -32767, maximum 32767 | ||
| 2 | moveY | int16 | obligatoire | minimum -32767, maximum 32767 | ||
| 3 | capturedAtUs | uint64 | obligatoire | — | Monotonic clock of the renderer when the input was read, in microseconds. |
Types — core-render/scene.yaml
Espace de noms sequa.core_render
Primitive énumération
Shape of an object. Temporary, until the glTF/USD asset pipeline.
| Valeur | Numéro | Description |
|---|---|---|
box | 0 | |
sphere | 1 | |
capsule | 2 | |
plane | 3 |
Visual table
Interchangeable visual representation of an object.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | primitive | Primitive | obligatoire | — | ||
| 1 | size | Vec3 | obligatoire | — | Size of the primitive, in meters. | |
| 2 | color | Color | obligatoire | — | Base color (linear). | |
| 3 | semanticClass | uint32 | obligatoire | — | Class written in the semantic mask; 0 means unclassified. |
Camera table
The scene camera.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | transform | Transform | obligatoire | — | ||
| 1 | verticalFovDeg | float32 | obligatoire | — | Vertical field of view, in degrees. | |
| 2 | near | float32 | obligatoire | — | Near clipping plane, in meters. | |
| 3 | far | float32 | obligatoire | — | Far clipping plane, in meters. |
CreateObject table
Create an object (op "create").
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | uint64 | obligatoire | minimum 1 | Persistent object id. | |
| 1 | transform | Transform | obligatoire | — | ||
| 2 | visual | Visual | obligatoire | — |
DestroyObject table
Destroy an object (op "destroy").
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | uint64 | obligatoire | minimum 1 | Persistent object id. |
SetTransform table
Move an object (op "transform"). The most frequent command.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | uint64 | obligatoire | minimum 1 | Persistent object id. | |
| 1 | transform | Transform | obligatoire | — |
SetVisual table
Change the look of an object (op "visual").
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | uint64 | obligatoire | minimum 1 | Persistent object id. | |
| 1 | visual | Visual | obligatoire | — |
SetCamera table
Place the camera (op "camera").
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | camera | Camera | obligatoire | — |
SceneCommand union
One scene command.
| Membre | Numéro | Table |
|---|---|---|
| CreateObject | 1 | CreateObject |
| DestroyObject | 2 | DestroyObject |
| SetTransform | 3 | SetTransform |
| SetVisual | 4 | SetVisual |
| SetCamera | 5 | SetCamera |
SceneDelta table
Commands that bring the scene to worldVersion, applied all at once or not at all.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | worldVersion | uint64 | obligatoire | — | Scene version reached after this delta. Strictly increasing, never reset (a Core counter, not the tick). | |
| 1 | tick | uint64 | obligatoire | — | Simulation tick that produced this delta. | |
| 2 | full | bool | défaut = false | — | Complete scene. The renderer first destroys every object it still knows, then applies the delta. | |
| 3 | sentAtUs | uint64 | obligatoire | — | Core monotonic clock when sent, in microseconds (shared by the processes of one machine), for the latency measurement. | |
| 4 | commands | [SceneCommand] | obligatoire | maxItems 100000 | Commands, applied in order. |
Types — studio-core/core.yaml
Espace de noms sequa.studio_core
CorePing table
Liveness check (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
CorePong table
Reply to core/ping (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
CoreStatusRequest table
Request for the Core status (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
CoreStatus table
Status of the Core.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | coreVersion | string | obligatoire | maxLength 64 | ||
| 1 | protocolVersion | string | obligatoire | maxLength 32 | ||
| 2 | instanceId | string | obligatoire | minLength 32, maxLength 32 | ||
| 3 | pid | uint32 | obligatoire | — | ||
| 4 | uptimeMs | uint64 | obligatoire | — | ||
| 5 | linked | bool | obligatoire | — | The lease is in force. | |
| 6 | controllerAttached | bool | obligatoire | — | A controller connection is attached. | |
| 7 | clients | uint32 | obligatoire | — | Open connections. |
CoreAttach table
The connection becomes the controller and the lease is put in force.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | force | bool | défaut = false | — | Take the role even if another controller is connected (it loses the role). |
CoreDetach table
Lift the lease (controller only); the Core goes on without a controller.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
LinkStatus table
State of the lease after core/attach or core/detach.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | linked | bool | obligatoire | — |
CoreShutdown table
Stop the Core cleanly (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
ShutdownAccepted table
Reply to core/shutdown, sent before the Core stops (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
Types — studio-core/events.yaml
Espace de noms sequa.studio_core
EventTopic énumération
Subject of events.
| Valeur | Numéro | Description |
|---|---|---|
render | 0 | |
project | 1 |
EventTopics table
Topics to subscribe to or unsubscribe from (at least one).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | topics | [EventTopic] | obligatoire | minItems 1, maxItems 16 |
Subscriptions table
Topics followed by the connection after the request.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | topics | [EventTopic] | obligatoire | maxItems 16 |
Types — studio-core/fs.yaml
Espace de noms sequa.studio_core
FsList table
List the sub-folders of a folder.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | path | string | facultatif | maxLength 4096 | Absolute folder to list. Absent or empty -> the user's home folder. |
FsMakeDir table
Create a folder in an existing folder, then list that parent folder again. The Core
refuses a name that is empty, ".", "..", contains "/", "\" or a character forbidden by
one of the supported systems (< > : " | ? * and control characters), or ends with a
space or a dot.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | parent | string | obligatoire | minLength 1, maxLength 4096 | ||
| 1 | name | string | obligatoire | minLength 1, maxLength 255 |
FsEntry table
A sub-folder.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | name | string | obligatoire | maxLength 1024 | ||
| 1 | project | bool | défaut = false | — | The folder contains a SEQUA project (a *.sequa file at its root). | |
| 2 | hidden | bool | défaut = false | — | Hidden folder (name starting with "." or hidden attribute on Windows). |
FsPlace table
A starting point for browsing (home folder, drive, root).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | label | string | obligatoire | maxLength 256 | ||
| 1 | path | string | obligatoire | maxLength 4096 |
FsListing table
Content of a folder: its sub-folders sorted by name (case-insensitive, then exact), and
the starting points of the machine. Entries beyond maxItems are left out (truncated).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | path | string | obligatoire | maxLength 4096 | Absolute path of the listed folder, normalized ("/" separators). | |
| 1 | parent | string | facultatif | maxLength 4096 | Parent folder; absent at the root of a drive or of the system. | |
| 2 | entries | [FsEntry] | obligatoire | maxItems 4096 | ||
| 3 | places | [FsPlace] | obligatoire | maxItems 64 | ||
| 4 | truncated | bool | défaut = false | — | More than 4096 sub-folders; the list is cut. | |
| 5 | project | bool | défaut = false | — | The listed folder itself contains a SEQUA project. |
Types — studio-core/handshake.yaml
Espace de noms sequa.studio_core
Welcome table
Reply of the Core to hello on the studio-core link.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | protocolVersion | string | obligatoire | maxLength 32 | Contract version of the Core. | |
| 1 | coreVersion | string | obligatoire | maxLength 64 | ||
| 2 | instanceId | string | obligatoire | minLength 32, maxLength 32 | 32 random hexadecimal characters drawn at start-up; identifies THIS run of the Core. | |
| 3 | pid | uint32 | obligatoire | — | Process id of the Core. | |
| 4 | linked | bool | obligatoire | — | The lease is in force (spec 0.4 §5). |
Types — studio-core/log.yaml
Espace de noms sequa.studio_core
LogProtocolLevel énumération
Level of the protocol log.
| Valeur | Numéro | Description |
|---|---|---|
off | 0 | |
summary | 1 | |
full | 2 |
LogProtocol table
Request to change the protocol log of the Core (sequa-core --protocol-log).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | level | LogProtocolLevel | obligatoire | — | ||
| 1 | logTimeout | uint8 | facultatif | minimum 0, maximum 30 | Drain timeout of the log at shutdown, in seconds, from 0 to 30. Absent leaves it unchanged (--protocol-log-timeout, 2 s by default). |
LogProtocolStatus table
Protocol log state of the Core (reply to log/protocol).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | level | LogProtocolLevel | obligatoire | — | ||
| 1 | logTimeout | uint8 | obligatoire | minimum 0, maximum 30 | Drain timeout of the log at shutdown, in seconds. |
Types — studio-core/project.yaml
Espace de noms sequa.studio_core
ProjectCreate table
Create a project in a new folder <parent>/<folder>, then open it. The Core creates the
standard tree (ADR 0015), the <name>.sequa file, a first Space, .gitignore, and the asset
catalog .sequa/catalog.sqdb (ADR 0016). The folder must not exist, or be empty.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | parent | string | obligatoire | minLength 1, maxLength 4096 | Existing absolute folder that receives the project folder. | |
| 1 | name | string | obligatoire | minLength 1, maxLength 128 | Displayed name of the project. | |
| 2 | folder | string | facultatif | maxLength 255 | Name of the project folder, also the stem of the .sequa file. Absent -> derived from the name (characters forbidden in a folder name replaced by "-"). | |
| 3 | description | string | facultatif | maxLength 1024 |
ProjectStatusRequest table
Request for the open project (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
ProjectSpace table
A Space of the open project.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 | UUID v4, lowercase, 36 characters. | |
| 1 | name | string | obligatoire | maxLength 128 | ||
| 2 | description | string | facultatif | maxLength 1024 | ||
| 3 | tags | [string] | facultatif | maxItems 32 | Tags of the Space, in the author's order. | |
| 4 | version | string | obligatoire | minLength 5, maxLength 64 | Version chosen by the author, semver ("1.2.0"), checked by the Core. | |
| 5 | active | bool | défaut = true | — | True -> the Space can be modified. False -> read only. | |
| 6 | thumbnailHash | string | facultatif | maxLength 128 | Hash of the thumbnail spaces/<folder>/SpaceThumb.<ext>, "blake3:" then 64 hexadecimal characters; absent when the Space has no thumbnail. Studio asks for the image again (space/thumbnail-get) only when this hash changes. |
ProjectInfo table
The open project.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 | UUID v4, lowercase, 36 characters. | |
| 1 | name | string | obligatoire | maxLength 128 | ||
| 2 | description | string | facultatif | maxLength 1024 | ||
| 3 | root | string | obligatoire | maxLength 4096 | Absolute path of the project folder ("/" separators). | |
| 4 | file | string | obligatoire | maxLength 4096 | Absolute path of the .sequa file ("/" separators). | |
| 5 | spaces | [ProjectSpace] | obligatoire | maxItems 4096 | ||
| 6 | defaultSpace | string | facultatif | maxLength 36 | Id of the Space opened by default. | |
| 7 | selectedSpace | string | facultatif | maxLength 36 | Id of the Space the workshops work on (ADR 0021). Kept by the Core and in the local file .sequa/workspace.json; set by space/select. |
ProjectStatus table
The open project, absent when no project is open.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | project | ProjectInfo | facultatif | — |
ProjectOpen table
Open an existing project, which replaces the open one. The Core reads and checks the
<name>.sequa file and every space.json against their schemas (ADR 0015), then prepares
the asset catalog (ADR 0016): an absent base is rebuilt from catalog/*.jsonl, a base of
another project or a damaged one is moved to .sequa/backups/<date>/ and rebuilt.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | path | string | obligatoire | minLength 1, maxLength 4096 | Absolute path of the project folder (exactly one *.sequa file at its root) or of its .sequa file. "/" or "\" separators. |
ProjectClose table
Close the open project (no content). Closing when no project is open is not an error.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
ProjectRecentRequest table
Request for the recent projects (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
ProjectRecentEntry table
A project recently created or opened on the Core's machine.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | file | string | obligatoire | maxLength 4096 | Absolute path of the .sequa file ("/" separators); value to send to project/open. | |
| 1 | name | string | obligatoire | maxLength 128 | Name of the project when it was last opened. | |
| 2 | id | string | facultatif | maxLength 36 | UUID v4 of the project when it was last opened. | |
| 3 | openedAtMs | uint64 | facultatif | — | Last opening, in milliseconds since 1970-01-01 UTC. | |
| 4 | missing | bool | défaut = false | — | The .sequa file no longer exists (moved or deleted); the entry stays listed. |
ProjectRecent table
Recent projects, most recent first, at most 16. The list is kept by the Core in the
user's settings folder (Windows: %APPDATA%/SEQUA/recent-projects.json; Linux:
$XDG_CONFIG_HOME/sequa or ~/.config/sequa; macOS: ~/Library/Application Support/SEQUA),
so it is the same from any browser.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | entries | [ProjectRecentEntry] | obligatoire | maxItems 16 |
Types — studio-core/render.yaml
Espace de noms sequa.studio_core
RenderAdapter énumération
3D engine adapter loaded by sequa-render.
| Valeur | Numéro | Description |
|---|---|---|
godot | 0 | |
debug | 1 |
RenderState énumération
State of the renderer process.
| Valeur | Numéro | Description |
|---|---|---|
stopped | 0 | |
starting | 1 | |
running | 2 | |
restarting | 3 |
RenderStart table
Parameters of the renderer to start.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | adapter | RenderAdapter | obligatoire | — | ||
| 1 | width | uint16 | défaut = 1280 | minimum 64, maximum 7680 | Frame width, in pixels. | |
| 2 | height | uint16 | défaut = 720 | minimum 64, maximum 7680 | Frame height, in pixels. | |
| 3 | headless | bool | défaut = false | — | Without a window (off-screen rendering). | |
| 4 | fps | uint16 | défaut = 0 | minimum 0, maximum 240 | Target frame rate, in frames per second; 0 lets the engine choose. |
RenderEngine table
Capabilities of the loaded engine (from render/ready).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | name | string | obligatoire | maxLength 64 | Engine name (godot, debug). | |
| 1 | version | string | obligatoire | maxLength 64 | Engine version actually used (4.7.2-stable). | |
| 2 | buffers | [string] | obligatoire | maxItems 16 | Frame buffers produced (color, depth, normals, motion_vectors, albedo, object_ids, semantic_mask). | |
| 3 | windowed | bool | obligatoire | — | The engine has its own game window. | |
| 4 | headless | bool | obligatoire | — | Off-screen rendering. | |
| 5 | playerInput | bool | obligatoire | — | The engine captures player input (ADR 0011). |
RenderStatus table
Render state (reply to render/start and render/status, content of render/changed).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | state | RenderState | obligatoire | — | ||
| 1 | adapter | RenderAdapter | facultatif | — | ||
| 2 | pid | uint32 | facultatif | — | Process id of sequa-render. Absent if there is no process. | |
| 3 | restarts | uint32 | obligatoire | — | Automatic restarts after a crash. | |
| 4 | engine | RenderEngine | facultatif | — | ||
| 5 | width | uint16 | facultatif | — | Frame width, in pixels. Absent until the renderer is ready. | |
| 6 | height | uint16 | facultatif | — | Frame height, in pixels. Absent until the renderer is ready. | |
| 7 | measurements | RenderMeasurements | facultatif | — | ||
| 8 | worldVersion | uint64 | obligatoire | — | Last scene version sent to the renderer (increases only when a scene/delta is sent, not at every tick). | |
| 9 | lastFailure | string | facultatif | maxLength 1000 | Last known failure. Absent if there was none. |
RenderStatusRequest table
Request for the render state (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
RenderStop table
Stop the renderer (no content). Never fails, even if the renderer is already stopped.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
Types — studio-core/session.yaml
Espace de noms sequa.studio_core
SessionStatus table
State of the live session.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | seed | uint64 | obligatoire | — | ||
| 1 | tickRateHz | uint32 | obligatoire | — | ||
| 2 | tick | uint64 | obligatoire | — | Ticks executed since the start of the session. | |
| 3 | stateHash | uint64 | obligatoire | — | Hash of the simulation state after the last tick. | |
| 4 | running | bool | obligatoire | — | ||
| 5 | inputCount | uint64 | obligatoire | — | Non-neutral inputs recorded. |
SessionStart table
Replace the current session with a new one, at tick 0, running.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | seed | uint64 | obligatoire | — |
SessionPause table
Pause the session (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
SessionResume table
Resume the session (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
SessionStatusRequest table
Request for the session state (no content).
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|
SessionInput table
Player input for the next executed tick. Several inputs before that tick: the last one
wins. It stays active (held input) until the next one.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | buttons | uint32 | obligatoire | — | Pressed actions, one bit each. | |
| 1 | moveX | int16 | obligatoire | minimum -32767, maximum 32767 | ||
| 2 | moveY | int16 | obligatoire | minimum -32767, maximum 32767 |
InputAccepted table
Reply to session/input.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | tick | uint64 | obligatoire | — | Tick the input will apply to. |
SessionExport table
Request for the recording of the session.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | includeHashes | bool | défaut = false | — | Also send the state hash after each tick. |
SessionExported table
Recording of the session, current tick and state hash.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | recording | Recording | obligatoire | — | ||
| 1 | tick | uint64 | obligatoire | — | ||
| 2 | stateHash | uint64 | obligatoire | — | ||
| 3 | hashes | [uint64] | facultatif | maxItems 10000000 | State hash after each tick (tick elements). Absent unless includeHashes. |
SessionImport table
Replay a recording as fast as possible (not in real time) with the current settings of
the Core; the session then goes on from there. Rejected recording: invalid-recording,
the current session is kept.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | recording | Recording | obligatoire | — | ||
| 1 | resume | bool | obligatoire | — | Running (true) or paused (false) after the replay. | |
| 2 | includeHashes | bool | défaut = false | — | Also send the state hash after each replayed tick. |
SessionImported table
Reply to session/import.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | session | SessionStatus | obligatoire | — | ||
| 1 | replayMs | float64 | obligatoire | minimum 0 | Duration of the replay, in milliseconds. | |
| 2 | hashes | [uint64] | facultatif | maxItems 10000000 | State hash after each replayed tick. Absent unless includeHashes. |
Types — studio-core/space.yaml
Espace de noms sequa.studio_core
SpaceCreate table
Create a Space in the opened project. Its folder spaces/<folder>/ is derived from the name
(forbidden characters replaced by "-") and made unique by a suffix (-2, -3...). The new
Space is Active; it is neither Default nor Selected.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | name | string | obligatoire | minLength 1, maxLength 128 | ||
| 1 | description | string | facultatif | maxLength 1024 | ||
| 2 | tags | [string] | facultatif | maxItems 32 | ||
| 3 | version | string | facultatif | maxLength 64 | Semver version ("1.2.0"). Absent -> "0.1.0". |
SpaceUpdate table
Replace the editable properties of a Space. Every field replaces the former value: an
absent description or tags is removed. A new name also renames the folder of the Space
(spaces/<folder>/, made unique by a suffix). Refused for a read-only Space.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 | UUID v4 of the Space. | |
| 1 | name | string | obligatoire | minLength 1, maxLength 128 | ||
| 2 | description | string | facultatif | maxLength 1024 | ||
| 3 | tags | [string] | facultatif | maxItems 32 | ||
| 4 | version | string | obligatoire | minLength 5, maxLength 64 | Semver version ("1.2.0"). |
SpaceDelete table
Delete a Space. Its folder is moved to .sequa/trash/<date>/spaces/<folder>/ and its entry
removed from the .sequa file. Refused for the Default Space and for a read-only Space.
When the deleted Space was Selected, the selection goes back to the Default Space.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 |
SpaceSelect table
Make a Space the Selected one (the Space the workshops work on). Kept by the Core and in
the local file .sequa/workspace.json, not in the shared project files.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 |
SpaceSetDefault table
Make a Space the Default one (the Space the game starts in), written in the .sequa file.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 |
SpaceSetActive table
Make a Space editable (active true) or read only (active false), written in its space.json.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 | ||
| 1 | active | bool | obligatoire | — |
SpaceThumbnailSet table
Set or remove the thumbnail of a Space. The Core writes spaces/<folder>/SpaceThumb.<ext>
and removes any former thumbnail, whatever its extension. Absent or empty data -> the
thumbnail is removed (an empty vector is the same as an absent one, as for tags). Refused
for a read-only Space.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 | ||
| 1 | mimeType | string | facultatif | maxLength 32 | image/png, image/jpeg or image/webp; required with data. | |
| 2 | data | bytes | facultatif | maxLength 2097152 | Content of the image file, 2 MiB at most. |
SpaceThumbnailGet table
Request for the thumbnail of a Space.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 |
SpaceThumbnail table
Thumbnail of a Space (reply to space/thumbnail-get). Absent data -> no thumbnail.
| Numéro | Nom | Type | Présence | Bornes | Déprécié | Description |
|---|---|---|---|---|---|---|
| 0 | id | string | obligatoire | maxLength 36 | ||
| 1 | mimeType | string | facultatif | maxLength 32 | ||
| 2 | data | bytes | facultatif | maxLength 2097152 |