diff --git a/README.md b/README.md new file mode 100644 index 0000000..fca9595 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +Flurry is a pixelflut compatible server written in rust +with a focus on minimizing latency while keeping high performance. + +## Protocols + +Multiple protocols are supported: +- Text: The default protocol, it is compliant with pixelflut but it defines some extra commands + - CANVAS : used to change to a completely seperate canvas, the amount and size is defined by the host + - PROTOCOL : used to change to different protocols, the useable names are: + - text: goes to the Text protocol + - binary: goes to the Binary protocol +- Binary: A binary analog to the text version, about twice as efficient with bandwidth, the commands are + - size: 0x73 -> + - help: 0x68 -> help message (in UTF-8) + - get pixel: 0x20 -> + - set pixel rgb: 0x80 + - blend pixel rgba: 0x81 + - set pixel grayscale: 0x82 + +