research_sync: README for the cluster research queue, review fixes

Document the cluster research queue in the plugin README and the root
README. Review fixes: ipairs for queue order, event annotations on the new
Lua handlers, an IpcQueue type, a test for clearing the queue, and drop the
controller import from test/missing.js.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
ILLISISandClaude Opus 5.5 committed 2026-10-18 21:54:10 +11:00
1 parent 7175571d5b
commit 1f6e0519bd
6 files changed
+41 -7

No files matched your search

+21
View File
@@ -2,6 +2,27 @@
Plugin synchronizing research progress between instances and the cluster.
## Research queue
Each server can follow one cluster research queue.
It is set from the normal research screen: queueing, moving or cancelling a technology there changes it for every following server.
So does a lab whose circuit "set research" picks a technology, and so can another mod.
The "Follow the cluster research queue" checkbox on the lab window turns this on or off per server.
Turning it on replaces the server's queue with the cluster's, turning it off clears it.
It is on by default.
On the first start after installing or upgrading, the first server to start shares its queue as the cluster queue, and later servers take it.
Every change prints a chat line on every server.
It needs Factorio 2.0.56 or later, older servers ignore the queue.
To turn it off without the GUI, run `/sc research_sync.set_follow(false)` on that server.
Known gaps:
- A script that assigns the queue directly to `{}` isn't seen.
- Two following servers whose labs want different research keep flipping the cluster queue, as two labs do on one server.
- A technology a server can't queue yet is dropped there, and an edit on that server then drops it for everyone.
## Installation