From 01e442c42e806f75f0289b1ed5e85a3498a586ab Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Thu, 28 Jan 2021 12:40:27 +0100 Subject: [PATCH] Mention WebSocket interface in docs Replace old paragraph in the developing for clusterio document about the removed HTTP interface with a notice of the new protocol running over WebSocket. --- docs/developing-for-clusterio.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/developing-for-clusterio.md b/docs/developing-for-clusterio.md index 76fd682b..c6c4271e 100644 --- a/docs/developing-for-clusterio.md +++ b/docs/developing-for-clusterio.md @@ -161,11 +161,13 @@ which accepts a table and calls `add_lib` for each value in the table. Communicating with Clusterio ---------------------------- -There's a poorly to virtuarly undocumented HTTP interface that can be -used to communicate with Clusterio to do things like get the status of -instances, grab items from the store, run commands on instances, etc, -etc. For now you can read the source code, and maybe ask on the Discord -for some pointers if you get stuck. +Clusterio uses a homebrew protocol based on sending JSON payloads over +a WebSocket connection. See [socket.md](socket.md) for the +implementation details of it. + +It's also possible to write a plugin for Clusterio that exposes a custom +interface over HTTP, WebSocket or any other technology supported by +Node.js. Clusterio Modules