Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 489 Bytes

README.md

File metadata and controls

35 lines (22 loc) · 489 Bytes

vLight Client Protocol

Connection

WebSocket

Connect to /websocket

Upon connection, the client will be sent the universe

HTTP/REST

Send a POST request to /api

  • Header: Content-Type: application/json
  • Set the message as request body

Success Response:

{ "ok": true }

Error Response:

{
  "ok": false,
  "error": string
}

Protocol / Messages

See the TypeScript definitions under shared/types/api.d.ts