SEQUA : contrat entre les programmes

Version du contrat : 0.7.1

Types — common/errors.yaml

Espace de noms sequa.common

ErrorCode énumération

Error codes of the Studio <-> Core and Core <-> render links.

ValeurNuméroDescription
invalid-message0
unknown-type1
invalid-payload2
render-running3
render-unavailable4
handshake-required5
incompatible-protocol6
unauthorized7
forbidden-origin8
controller-exists9
not-controller10
invalid-recording11
render-exists12
path-not-found13
path-denied14
already-exists15
invalid-name16
io-failure17
not-a-project18
invalid-project19
newer-project20
no-project21
space-not-found22
space-read-only23
default-space24
invalid-image25

Error table

Rejection of a request, or connection error.

NuméroNomTypePrésenceBornesDépréciéDescription
0codeErrorCodeobligatoire—
1messagestringfacultatifmaxLength 1000Human-readable explanation, in English (logs, debugging).

Types — common/geometry.yaml

Espace de noms sequa.common

Vec3 struct

3D vector (position, size, scale).

NuméroNomTypePrésenceBornesDépréciéDescription
0xfloat32obligatoire—
1yfloat32obligatoire—
2zfloat32obligatoire—

Quat struct

Unit quaternion (x, y, z, w).

NuméroNomTypePrésenceBornesDépréciéDescription
0xfloat32obligatoire—
1yfloat32obligatoire—
2zfloat32obligatoire—
3wfloat32obligatoire—

Color struct

Linear color (not sRGB), components between 0 and 1.

NuméroNomTypePrésenceBornesDépréciéDescription
0rfloat32obligatoire—
1gfloat32obligatoire—
2bfloat32obligatoire—
3afloat32obligatoire—

Transform struct

Position, rotation and scale of an object.

NuméroNomTypePrésenceBornesDépréciéDescription
0positionVec3obligatoire—
1rotationQuatobligatoire—
2scaleVec3obligatoire—

Types — common/handshake.yaml

Espace de noms sequa.common

Client énumération

The program that opens the connection.

ValeurNuméroDescription
sequa-studio0
sequa-studio-host1
sequa-render2

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éroNomTypePrésenceBornesDépréciéDescription
0protocolVersionstringobligatoireminLength 5, maxLength 32Contract version of the sender (major.minor.patch, optionally followed by -... or
+...). Compatible: same major and, while the major is 0, same minor.
1clientClientobligatoire—

Types — common/measurements.yaml

Espace de noms sequa.common

RenderMeasurements table

Render measurements over the last second.

NuméroNomTypePrésenceBornesDépréciéDescription
0framesPerSeconduint32obligatoire—Frames rendered during the last second.
1cpuMsMedianfloat32obligatoire—Median CPU time per frame, in milliseconds.
2cpuMsP95float32obligatoire—95th percentile CPU time per frame, in milliseconds.
3latencyUsMedianfloat32obligatoire—Median transport latency, in microseconds (end of tick -> delta received by the renderer).
4latencyUsP95float32obligatoire—95th percentile transport latency, in microseconds (end of tick -> delta received by the renderer).
5applyUsMedianfloat32obligatoire—Median apply time, in microseconds (end of tick -> delta applied, frame wait included).
6applyUsP95float32obligatoire—95th percentile apply time, in microseconds (end of tick -> delta applied, frame wait included).
7gpuMsMedianfloat32facultatif—Median GPU time per frame, in milliseconds. Absent if the engine does not measure the GPU.
8gpuMsP95float32facultatif—95th percentile GPU time per frame, in milliseconds. Absent if the engine does not measure the GPU.
9vramBytesuint64facultatif—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éroNomTypePrésenceBornesDépréciéDescription
0tickuint64obligatoire—
1buttonsuint32obligatoire—Pressed actions, one bit each.
2moveXint16obligatoire—
3moveYint16obligatoire—

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éroNomTypePrésenceBornesDépréciéDescription
0seeduint64obligatoire—
1tickRateHzuint32obligatoireminimum 1, maximum 10000Fixed simulation rate, in ticks per second.
2tickCountuint64obligatoire—Ticks executed since the start of the session.
3inputs[InputFrame]obligatoiremaxItems 10000000Non-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éroNomTypePrésenceBornesDépréciéDescription
0protocolVersionstringobligatoiremaxLength 32Contract version of the Core.
1coreVersionstringobligatoiremaxLength 64
2instanceIdstringobligatoireminLength 32, maxLength 32Identifies this run of the Core (32 hexadecimal characters).
3renderIdstringobligatoireminLength 32, maxLength 32Identifies 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éroNomTypePrésenceBornesDépréciéDescription
0lastWorldVersionuint64obligatoire—Scene version shown by the last frame.
1measurementsRenderMeasurementsobligatoire—

RenderCapabilities table

Capabilities of the engine loaded by the adapter.

NuméroNomTypePrésenceBornesDépréciéDescription
0engineNamestringobligatoireminLength 1, maxLength 64Engine name (godot, debug).
1engineVersionstringobligatoiremaxLength 64Engine version actually used (4.7.2-stable).
2buffers[string]obligatoiremaxItems 16Frame buffers produced (color, depth, normals, motion_vectors, albedo, object_ids, semantic_mask).
3windowedboolobligatoire—The engine has its own game window.
4headlessboolobligatoire—Off-screen rendering.
5playerInputboolobligatoire—The engine captures player input (ADR 0011).

RenderReady table

The adapter started; sent once, right after welcome.

NuméroNomTypePrésenceBornesDépréciéDescription
0capabilitiesRenderCapabilitiesobligatoire—
1widthuint16obligatoireminimum 1Frame width, in pixels.
2heightuint16obligatoireminimum 1Frame height, in pixels.

RenderFailure énumération

Why the renderer stops.

ValeurNuméroDescription
adapter-load0
adapter-start1
invalid-delta2
render-frame3
invalid-message4

RenderFailed table

The renderer failed; it closes the connection and exits with code 1.

NuméroNomTypePrésenceBornesDépréciéDescription
0codeRenderFailureobligatoire—
1messagestringfacultatifmaxLength 1000Human-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éroNomTypePrésenceBornesDépréciéDescription

RenderStop table

Stop the adapter and exit with code 0 (no content).

NuméroNomTypePrésenceBornesDé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éroNomTypePrésenceBornesDépréciéDescription
0buttonsuint32obligatoire—Pressed actions, one bit each.
1moveXint16obligatoireminimum -32767, maximum 32767
2moveYint16obligatoireminimum -32767, maximum 32767
3capturedAtUsuint64obligatoire—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.

ValeurNuméroDescription
box0
sphere1
capsule2
plane3

Visual table

Interchangeable visual representation of an object.

NuméroNomTypePrésenceBornesDépréciéDescription
0primitivePrimitiveobligatoire—
1sizeVec3obligatoire—Size of the primitive, in meters.
2colorColorobligatoire—Base color (linear).
3semanticClassuint32obligatoire—Class written in the semantic mask; 0 means unclassified.

Camera table

The scene camera.

NuméroNomTypePrésenceBornesDépréciéDescription
0transformTransformobligatoire—
1verticalFovDegfloat32obligatoire—Vertical field of view, in degrees.
2nearfloat32obligatoire—Near clipping plane, in meters.
3farfloat32obligatoire—Far clipping plane, in meters.

CreateObject table

Create an object (op "create").

NuméroNomTypePrésenceBornesDépréciéDescription
0iduint64obligatoireminimum 1Persistent object id.
1transformTransformobligatoire—
2visualVisualobligatoire—

DestroyObject table

Destroy an object (op "destroy").

NuméroNomTypePrésenceBornesDépréciéDescription
0iduint64obligatoireminimum 1Persistent object id.

SetTransform table

Move an object (op "transform"). The most frequent command.

NuméroNomTypePrésenceBornesDépréciéDescription
0iduint64obligatoireminimum 1Persistent object id.
1transformTransformobligatoire—

SetVisual table

Change the look of an object (op "visual").

NuméroNomTypePrésenceBornesDépréciéDescription
0iduint64obligatoireminimum 1Persistent object id.
1visualVisualobligatoire—

SetCamera table

Place the camera (op "camera").

NuméroNomTypePrésenceBornesDépréciéDescription
0cameraCameraobligatoire—

SceneCommand union

One scene command.

MembreNuméroTable
CreateObject1CreateObject
DestroyObject2DestroyObject
SetTransform3SetTransform
SetVisual4SetVisual
SetCamera5SetCamera

SceneDelta table

Commands that bring the scene to worldVersion, applied all at once or not at all.

NuméroNomTypePrésenceBornesDépréciéDescription
0worldVersionuint64obligatoire—Scene version reached after this delta. Strictly increasing, never reset (a Core counter, not the tick).
1tickuint64obligatoire—Simulation tick that produced this delta.
2fullbooldéfaut = false—Complete scene. The renderer first destroys every object it still knows, then applies the delta.
3sentAtUsuint64obligatoire—Core monotonic clock when sent, in microseconds (shared by the processes of one machine), for the latency measurement.
4commands[SceneCommand]obligatoiremaxItems 100000Commands, applied in order.

Types — studio-core/core.yaml

Espace de noms sequa.studio_core

CorePing table

Liveness check (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

CorePong table

Reply to core/ping (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

CoreStatusRequest table

Request for the Core status (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

CoreStatus table

Status of the Core.

NuméroNomTypePrésenceBornesDépréciéDescription
0coreVersionstringobligatoiremaxLength 64
1protocolVersionstringobligatoiremaxLength 32
2instanceIdstringobligatoireminLength 32, maxLength 32
3piduint32obligatoire—
4uptimeMsuint64obligatoire—
5linkedboolobligatoire—The lease is in force.
6controllerAttachedboolobligatoire—A controller connection is attached.
7clientsuint32obligatoire—Open connections.

CoreAttach table

The connection becomes the controller and the lease is put in force.

NuméroNomTypePrésenceBornesDépréciéDescription
0forcebooldé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éroNomTypePrésenceBornesDépréciéDescription

LinkStatus table

State of the lease after core/attach or core/detach.

NuméroNomTypePrésenceBornesDépréciéDescription
0linkedboolobligatoire—

CoreShutdown table

Stop the Core cleanly (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

ShutdownAccepted table

Reply to core/shutdown, sent before the Core stops (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

Types — studio-core/events.yaml

Espace de noms sequa.studio_core

EventTopic énumération

Subject of events.

ValeurNuméroDescription
render0
project1

EventTopics table

Topics to subscribe to or unsubscribe from (at least one).

NuméroNomTypePrésenceBornesDépréciéDescription
0topics[EventTopic]obligatoireminItems 1, maxItems 16

Subscriptions table

Topics followed by the connection after the request.

NuméroNomTypePrésenceBornesDépréciéDescription
0topics[EventTopic]obligatoiremaxItems 16

Types — studio-core/fs.yaml

Espace de noms sequa.studio_core

FsList table

List the sub-folders of a folder.

NuméroNomTypePrésenceBornesDépréciéDescription
0pathstringfacultatifmaxLength 4096Absolute 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éroNomTypePrésenceBornesDépréciéDescription
0parentstringobligatoireminLength 1, maxLength 4096
1namestringobligatoireminLength 1, maxLength 255

FsEntry table

A sub-folder.

NuméroNomTypePrésenceBornesDépréciéDescription
0namestringobligatoiremaxLength 1024
1projectbooldéfaut = false—The folder contains a SEQUA project (a *.sequa file at its root).
2hiddenbooldéfaut = false—Hidden folder (name starting with "." or hidden attribute on Windows).

FsPlace table

A starting point for browsing (home folder, drive, root).

NuméroNomTypePrésenceBornesDépréciéDescription
0labelstringobligatoiremaxLength 256
1pathstringobligatoiremaxLength 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éroNomTypePrésenceBornesDépréciéDescription
0pathstringobligatoiremaxLength 4096Absolute path of the listed folder, normalized ("/" separators).
1parentstringfacultatifmaxLength 4096Parent folder; absent at the root of a drive or of the system.
2entries[FsEntry]obligatoiremaxItems 4096
3places[FsPlace]obligatoiremaxItems 64
4truncatedbooldéfaut = false—More than 4096 sub-folders; the list is cut.
5projectbooldé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éroNomTypePrésenceBornesDépréciéDescription
0protocolVersionstringobligatoiremaxLength 32Contract version of the Core.
1coreVersionstringobligatoiremaxLength 64
2instanceIdstringobligatoireminLength 32, maxLength 3232 random hexadecimal characters drawn at start-up; identifies THIS run of the Core.
3piduint32obligatoire—Process id of the Core.
4linkedboolobligatoire—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.

ValeurNuméroDescription
off0
summary1
full2

LogProtocol table

Request to change the protocol log of the Core (sequa-core --protocol-log).

NuméroNomTypePrésenceBornesDépréciéDescription
0levelLogProtocolLevelobligatoire—
1logTimeoutuint8facultatifminimum 0, maximum 30Drain 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éroNomTypePrésenceBornesDépréciéDescription
0levelLogProtocolLevelobligatoire—
1logTimeoutuint8obligatoireminimum 0, maximum 30Drain 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éroNomTypePrésenceBornesDépréciéDescription
0parentstringobligatoireminLength 1, maxLength 4096Existing absolute folder that receives the project folder.
1namestringobligatoireminLength 1, maxLength 128Displayed name of the project.
2folderstringfacultatifmaxLength 255Name of the project folder, also the stem of the .sequa file. Absent -> derived from
the name (characters forbidden in a folder name replaced by "-").
3descriptionstringfacultatifmaxLength 1024

ProjectStatusRequest table

Request for the open project (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

ProjectSpace table

A Space of the open project.

NuméroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 36UUID v4, lowercase, 36 characters.
1namestringobligatoiremaxLength 128
2descriptionstringfacultatifmaxLength 1024
3tags[string]facultatifmaxItems 32Tags of the Space, in the author's order.
4versionstringobligatoireminLength 5, maxLength 64Version chosen by the author, semver ("1.2.0"), checked by the Core.
5activebooldéfaut = true—True -> the Space can be modified. False -> read only.
6thumbnailHashstringfacultatifmaxLength 128Hash 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éroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 36UUID v4, lowercase, 36 characters.
1namestringobligatoiremaxLength 128
2descriptionstringfacultatifmaxLength 1024
3rootstringobligatoiremaxLength 4096Absolute path of the project folder ("/" separators).
4filestringobligatoiremaxLength 4096Absolute path of the .sequa file ("/" separators).
5spaces[ProjectSpace]obligatoiremaxItems 4096
6defaultSpacestringfacultatifmaxLength 36Id of the Space opened by default.
7selectedSpacestringfacultatifmaxLength 36Id 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éroNomTypePrésenceBornesDépréciéDescription
0projectProjectInfofacultatif—

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éroNomTypePrésenceBornesDépréciéDescription
0pathstringobligatoireminLength 1, maxLength 4096Absolute 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éroNomTypePrésenceBornesDépréciéDescription

ProjectRecentRequest table

Request for the recent projects (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

ProjectRecentEntry table

A project recently created or opened on the Core's machine.

NuméroNomTypePrésenceBornesDépréciéDescription
0filestringobligatoiremaxLength 4096Absolute path of the .sequa file ("/" separators); value to send to project/open.
1namestringobligatoiremaxLength 128Name of the project when it was last opened.
2idstringfacultatifmaxLength 36UUID v4 of the project when it was last opened.
3openedAtMsuint64facultatif—Last opening, in milliseconds since 1970-01-01 UTC.
4missingbooldé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éroNomTypePrésenceBornesDépréciéDescription
0entries[ProjectRecentEntry]obligatoiremaxItems 16

Types — studio-core/render.yaml

Espace de noms sequa.studio_core

RenderAdapter énumération

3D engine adapter loaded by sequa-render.

ValeurNuméroDescription
godot0
debug1

RenderState énumération

State of the renderer process.

ValeurNuméroDescription
stopped0
starting1
running2
restarting3

RenderStart table

Parameters of the renderer to start.

NuméroNomTypePrésenceBornesDépréciéDescription
0adapterRenderAdapterobligatoire—
1widthuint16défaut = 1280minimum 64, maximum 7680Frame width, in pixels.
2heightuint16défaut = 720minimum 64, maximum 7680Frame height, in pixels.
3headlessbooldéfaut = false—Without a window (off-screen rendering).
4fpsuint16défaut = 0minimum 0, maximum 240Target frame rate, in frames per second; 0 lets the engine choose.

RenderEngine table

Capabilities of the loaded engine (from render/ready).

NuméroNomTypePrésenceBornesDépréciéDescription
0namestringobligatoiremaxLength 64Engine name (godot, debug).
1versionstringobligatoiremaxLength 64Engine version actually used (4.7.2-stable).
2buffers[string]obligatoiremaxItems 16Frame buffers produced (color, depth, normals, motion_vectors, albedo, object_ids, semantic_mask).
3windowedboolobligatoire—The engine has its own game window.
4headlessboolobligatoire—Off-screen rendering.
5playerInputboolobligatoire—The engine captures player input (ADR 0011).

RenderStatus table

Render state (reply to render/start and render/status, content of render/changed).

NuméroNomTypePrésenceBornesDépréciéDescription
0stateRenderStateobligatoire—
1adapterRenderAdapterfacultatif—
2piduint32facultatif—Process id of sequa-render. Absent if there is no process.
3restartsuint32obligatoire—Automatic restarts after a crash.
4engineRenderEnginefacultatif—
5widthuint16facultatif—Frame width, in pixels. Absent until the renderer is ready.
6heightuint16facultatif—Frame height, in pixels. Absent until the renderer is ready.
7measurementsRenderMeasurementsfacultatif—
8worldVersionuint64obligatoire—Last scene version sent to the renderer (increases only when a scene/delta is sent, not at every tick).
9lastFailurestringfacultatifmaxLength 1000Last known failure. Absent if there was none.

RenderStatusRequest table

Request for the render state (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

RenderStop table

Stop the renderer (no content). Never fails, even if the renderer is already stopped.

NuméroNomTypePrésenceBornesDépréciéDescription

Types — studio-core/session.yaml

Espace de noms sequa.studio_core

SessionStatus table

State of the live session.

NuméroNomTypePrésenceBornesDépréciéDescription
0seeduint64obligatoire—
1tickRateHzuint32obligatoire—
2tickuint64obligatoire—Ticks executed since the start of the session.
3stateHashuint64obligatoire—Hash of the simulation state after the last tick.
4runningboolobligatoire—
5inputCountuint64obligatoire—Non-neutral inputs recorded.

SessionStart table

Replace the current session with a new one, at tick 0, running.

NuméroNomTypePrésenceBornesDépréciéDescription
0seeduint64obligatoire—

SessionPause table

Pause the session (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

SessionResume table

Resume the session (no content).

NuméroNomTypePrésenceBornesDépréciéDescription

SessionStatusRequest table

Request for the session state (no content).

NuméroNomTypePrésenceBornesDé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éroNomTypePrésenceBornesDépréciéDescription
0buttonsuint32obligatoire—Pressed actions, one bit each.
1moveXint16obligatoireminimum -32767, maximum 32767
2moveYint16obligatoireminimum -32767, maximum 32767

InputAccepted table

Reply to session/input.

NuméroNomTypePrésenceBornesDépréciéDescription
0tickuint64obligatoire—Tick the input will apply to.

SessionExport table

Request for the recording of the session.

NuméroNomTypePrésenceBornesDépréciéDescription
0includeHashesbooldéfaut = false—Also send the state hash after each tick.

SessionExported table

Recording of the session, current tick and state hash.

NuméroNomTypePrésenceBornesDépréciéDescription
0recordingRecordingobligatoire—
1tickuint64obligatoire—
2stateHashuint64obligatoire—
3hashes[uint64]facultatifmaxItems 10000000State 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éroNomTypePrésenceBornesDépréciéDescription
0recordingRecordingobligatoire—
1resumeboolobligatoire—Running (true) or paused (false) after the replay.
2includeHashesbooldéfaut = false—Also send the state hash after each replayed tick.

SessionImported table

Reply to session/import.

NuméroNomTypePrésenceBornesDépréciéDescription
0sessionSessionStatusobligatoire—
1replayMsfloat64obligatoireminimum 0Duration of the replay, in milliseconds.
2hashes[uint64]facultatifmaxItems 10000000State 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éroNomTypePrésenceBornesDépréciéDescription
0namestringobligatoireminLength 1, maxLength 128
1descriptionstringfacultatifmaxLength 1024
2tags[string]facultatifmaxItems 32
3versionstringfacultatifmaxLength 64Semver 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éroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 36UUID v4 of the Space.
1namestringobligatoireminLength 1, maxLength 128
2descriptionstringfacultatifmaxLength 1024
3tags[string]facultatifmaxItems 32
4versionstringobligatoireminLength 5, maxLength 64Semver 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éroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 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éroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 36

SpaceSetDefault table

Make a Space the Default one (the Space the game starts in), written in the .sequa file.

NuméroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 36

SpaceSetActive table

Make a Space editable (active true) or read only (active false), written in its space.json.

NuméroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 36
1activeboolobligatoire—

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éroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 36
1mimeTypestringfacultatifmaxLength 32image/png, image/jpeg or image/webp; required with data.
2databytesfacultatifmaxLength 2097152Content of the image file, 2 MiB at most.

SpaceThumbnailGet table

Request for the thumbnail of a Space.

NuméroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 36

SpaceThumbnail table

Thumbnail of a Space (reply to space/thumbnail-get). Absent data -> no thumbnail.

NuméroNomTypePrésenceBornesDépréciéDescription
0idstringobligatoiremaxLength 36
1mimeTypestringfacultatifmaxLength 32
2databytesfacultatifmaxLength 2097152