diff --git a/README.md b/README.md index c8b8831..9aaac5c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,3 @@ # sla_slicer A work in progress FOSS slicer for resin printers. - -## References - -- [GOO Format Spec](https://github.com/elegooofficial/GOO) diff --git a/goo_format/README.md b/goo_format/README.md new file mode 100644 index 0000000..c7d57df --- /dev/null +++ b/goo_format/README.md @@ -0,0 +1,8 @@ +# `goo_format` + +Library for encoding and decoding Elegoo's proprietary `.goo` file format. +A binary is also included for inspecting and debugging the sliced goo files, with the option to dump the layers as png images. + +If you ended up here trying to learn more about the format, make sure you read the [official format spec](https://github.com/elegooofficial/GOO). +Some things aren't mentioned in the spec like how everything is big-endian, the checksum is just the negated sum of all bytes in the payload, and the image data encoding specification is hard to follow, so look at [my implementation](src/encoded_layer.rs). +Also, if you use [ImHex](https://imhex.werwolv.net), I have created a pattern file ([goo.hexpat](goo.hexpat)) that may be helpful.