server icon indicating copy to clipboard operation
server copied to clipboard

[After TMM] Revise protocol documentation

Open Askaholic opened this issue 6 years ago • 4 comments

We really need a dedicated server protocol document where we write down what messages are sent by the client, and what responses come from the server. That way the client developers can have something to reference without needing to read the server code. This would also push us toward defined protocol versions where we can explicitly say "version 1.0 has exactly these commands".

Ideally we would refactor the server so that much of this documentation could be generated automatically from doc strings.

Askaholic avatar Jul 28 '19 04:07 Askaholic

how about implementing the hole protocol into a webassembly module, witch can be shared between the server and client ?

KaukaHan avatar Nov 22 '21 10:11 KaukaHan

I’m not sure how that would work. Can you elaborate?

Askaholic avatar Nov 22 '21 15:11 Askaholic

I am always surprised a little that the protocol was never defined in a third repo using like Google protobuf that allows it to be cross language

Sheikah45 avatar Nov 22 '21 16:11 Sheikah45

https://webassembly.org/ https://wasmer.io/ tldr: webassembly and wasmer would allow to compile into a platform indepenent, efficient, sandboxed, binary format witch can be embed into other software. the biggest problem i think is, you need a compiled language to compile into wasm, like c/c++ or rust. might be overkill therefor.

KaukaHan avatar Nov 22 '21 20:11 KaukaHan