aboutsummaryrefslogtreecommitdiff
path: root/mod/README.md
diff options
context:
space:
mode:
authorTrumeet <yuuta@yuuta.moe>2022-07-27 11:04:45 -0700
committerTrumeet <yuuta@yuuta.moe>2022-07-27 11:04:45 -0700
commit3a450ee1759b3df38d698daabdfafd0447d8223a (patch)
tree1c3b3e1e5fa85a914e4cb480f19f280f827c5eb4 /mod/README.md
parentc4bce9d7c539240242fce35162d74160725bbfe3 (diff)
downloadacron-3a450ee1759b3df38d698daabdfafd0447d8223a.tar
acron-3a450ee1759b3df38d698daabdfafd0447d8223a.tar.gz
acron-3a450ee1759b3df38d698daabdfafd0447d8223a.tar.bz2
acron-3a450ee1759b3df38d698daabdfafd0447d8223a.zip
feat(mod): enforce cmd response ordering and termination
Diffstat (limited to 'mod/README.md')
-rw-r--r--mod/README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/mod/README.md b/mod/README.md
index d84a718..1e23817 100644
--- a/mod/README.md
+++ b/mod/README.md
@@ -212,7 +212,7 @@ Parameters:
**Command result:**
-When the command finishes without issues (?), Acron will send the following response:
+When the command finishes, Acron will send the following response:
```json
{
@@ -225,11 +225,12 @@ When the command finishes without issues (?), Acron will send the following resp
All parameters always present.
-> **Note**
+> **Important:**
>
-> The result completely depends on Minecraft server's response.
-> It may not be reliable, and the values of `.result` and `.success` are
-> undocumented.
+> For `cmd` requests, the response will be either a single `error`, or a series of:
+> single `ok` (Successfully scheduled) -> zero or more `cmd_out` (Output) -> single `cmd_result` (Final result)
+> The response will always end with either error or cmd_result.
+> After that, the server should not return anything with the same ID.
### Receiving Messages