Commit all code. Should be mostly functional.

2024-12-31 03:38:40 -07:00
commit b4e9727e8c
15 changed files with 622 additions and 0 deletions
@@ -0,0 +1,30 @@
+# go-opds-pse
+
+A tiny lightweight OPDS server with PSE support. Mainly written for those using Panels on iOS.
+
+### Usage
+To use this, just download the [Latest Release](https://github.com/sclark-dev/go-opds-pse/releases/latest) and run it via terminal.
+
+```shell
+go-opds-pse -m "./manga/" serve -p 8080
+```
+
+### Building
+To build this you'll want the latest version of Go. Doesn't use any external libraries.
+
+### Attributions
+Thanks to [dir2opds](https://github.com/dubyte/dir2opds) for the inspiration for this.
+
+### FAQs
+- Why Go?
+    
+Well, Go is just very memory efficient. Yes, writing this in something like C would be even better, but that's a pain. My choice for Go was a cross-platform server that can be run on embedded hardware for local access to your comic/manga collection.
+
+- Is there a Web UI for this?
+
+No. This is designed to be a very lightweight server and a UI would add a lot of bulk. However since this server just serves a basic OPDS feed, there should be plenty of clients available. Alas, the PSE support is kinda lacking. It seems like there just isn't much of a market for that.
+
+- Does streaming use more bandwidth?
+
+Not really. While CBZ files are compressed, *generally* the bandwidth saved by compressing JPGs and non-lossless PNGs is pretty minimal. In fact, I don'
+t compress my CBZ files at all. The few hundred kilobytes it saves just isn't enough to justify the extra battery usage to decompress it on a mobile device.