From 77be5b9e6e0c482db95fdf8d458122e03f645633 Mon Sep 17 00:00:00 2001 From: Reinout Meliesie Date: Fri, 14 Mar 2025 19:09:43 +0100 Subject: [PATCH] Expand rough design document --- documentation/design.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/documentation/design.md b/documentation/design.md index 77cde1e..d975306 100644 --- a/documentation/design.md +++ b/documentation/design.md @@ -3,6 +3,15 @@ - The integrated hardware + software solution will be called "Zoöbox". The Linux application that can also be used separately will continue to be called "Zoödex". +- Separation of concerns: Zoöbox encompasses the hardware, operating system, handling torrent transfers and local system configuration. + Zoödex simply reads this data and writes only to the local database. + +- If enabled via a Cargo feature Zoödex can obtain real-time information about e.g. transfer progress in a well-defined way. + This is how within the Zoödex application the user will be able to e.g. request downloading a piece of media. + This should (in theory anyway) not be specific to Zoöbox. + +- Zoöbox will have additional applications to set local configuration, such as for wifi and VPN. + - There will be two Zoödex SQLite databases that complement each other. - `$XDG_DATA_HOME/zoodex/shared.sqlite` will be downloaded over IPv6 + HTTPS from `kernelmaft.com` and contain information about the films and series themselves, their bittorrent magnet links, and what files and tracks within each torrent to use. @@ -49,7 +58,8 @@ Depending on the window manager we end up using we may also require 2D OpenGL or Vulkan acceleration. This will more likely hinge on the availability of drivers than on the hardware itself. -- As a window manager we can consider Niri, Sway or even Cage. +- As a window manager we can consider for example Niri or Sway. + Single-executable window managers such as Cage are probably not a good fit because we will have multiple applications. - Controlling the UI will be done via a remote-like smartphone app. We can connect over wifi or bluetooth.