noa/flurry
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat: add readme

Browse source
This commit is contained in:
Noa Aarts 2024-10-05 17:15:30 +02:00
parent e31e982b00
commit 848a781aab
Signed by: noa
GPG key ID: 1850932741EFF672
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md Normal file
View file

@ -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 <id>: used to change to a completely seperate canvas, the amount and size is defined by the host
- PROTOCOL <protocol name>: 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 <u8 canvas> -> <u16_le x> <u16_le y>
- help: 0x68 -> help message (in UTF-8)
- get pixel: 0x20 <u8 canvas> <u16_le x> <u16_le y> -> <u8 red> <u8 green> <u8 blue>
- set pixel rgb: 0x80 <u8 canvas> <u16_le x> <u16_le y> <u8 red> <u8 green> <u8 blue>
- blend pixel rgba: 0x81 <u8 canvas> <u16_le x> <u16_le y> <u8 red> <u8 green> <u8 blue> <u8 blend>
- set pixel grayscale: 0x82 <u8 canvas> <u16_le x> <u16_le y> <u8 white>