diff --git a/src/BizHawk.Client.Common/Api/SocketServer.cs b/src/BizHawk.Client.Common/Api/SocketServer.cs
index 7de856506b..0869935dc0 100644
--- a/src/BizHawk.Client.Common/Api/SocketServer.cs
+++ b/src/BizHawk.Client.Common/Api/SocketServer.cs
@@ -71,6 +71,9 @@ namespace BizHawk.Client.Common
public string GetInfo() => $"{_targetAddr.HostIP}:{_targetAddr.Port}";
+ ///
+ /// Since BizHawk 2.6.2, all responses must be of the form $"{msg.Length:D} {msg}" i.e. prefixed with the length in base-10 and a space.
+ ///
public string ReceiveString(Encoding encoding = null)
{
if (!Connected)
diff --git a/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs b/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs
index 1a5376ae47..efa7f34bfd 100644
--- a/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs
+++ b/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs
@@ -68,7 +68,7 @@ namespace BizHawk.Client.Common
return APIs.Comm.Sockets.SendBytes(_th.EnumerateValues(byteArray).Select(d => (byte) d).ToArray());
}
- [LuaMethod("socketServerResponse", "receives a message from the Socket server")]
+ [LuaMethod("socketServerResponse", "Receives a message from the Socket server. Since BizHawk 2.6.2, all responses must be of the form $\"{msg.Length:D} {msg}\" i.e. prefixed with the length in base-10 and a space.")]
[return: LuaArbitraryStringParam]
public string SocketServerResponse()
{