[{"_1":2,"_176":-5,"_177":-5},"loaderData",{"_3":4,"_18":19,"_26":27,"_153":154},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16,"_17":11},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","dockerRebrandTour","routes/_layout",{"_20":-5,"_21":22,"_23":22,"_24":11,"_25":22},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_28":29,"_30":-5,"_31":11,"_32":11,"_33":34,"_35":36,"_37":-5,"_38":11,"_39":40,"_93":-5,"_94":95,"_141":-5,"_142":11,"_143":22,"_144":11,"_145":11,"_146":-5,"_147":11,"_148":-5,"_149":150,"_151":96,"_152":-7},"canonicalUrl","https://hub.docker.com/r/hiddenath/bookhaven/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","hiddenath","reponame","bookhaven","cloudBuildSource","isAutobuildsAvailable","repo",{"_41":42,"_48":49,"_51":52,"_53":54,"_55":11,"_56":57,"_58":59,"_60":61,"_44":36,"_33":34,"_63":64,"_65":-5,"_66":67,"_68":67,"_69":70,"_71":-5,"_72":73,"_74":75,"_76":11,"_77":34,"_78":79,"_84":11,"_85":86,"_90":34,"_91":92},"categories",[43],{"_44":45,"_46":47},"name","Web servers","slug","web-servers","content_types",[50],"image","date_registered","2026-09-03T23:24:54.056427Z","description","A self-contained 3D e-book reader — a web application that simulates a physical book","is_private","last_updated","2026-09-05T01:51:40.9966Z","last_modified","2026-09-04T16:06:24.020322Z","media_types",[62],"application/vnd.oci.image.index.v1+json","pull_count",329,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","# 📖 BookHaven 3D\n\n**A self-contained 3D e-book reader** — a web application that simulates a physical book in three-dimensional space. No build step, no Node.js, no npm — just a browser and Python.\n\n> 🌐 **Live demo**: [129.151.144.75:8080](http://129.151.144.75:8080/) — try it before installing\n\n## 🎬 Demo\n\n> ⚠️ The media below is large — click to expand (high traffic, ~9 MB total).\n\n

▶️ 3D page-flip animation (GIF, ~3.7 MB)

\n\n![3D page-flip animation](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/gif/reader-flip.gif)\n\n

\n\n

📱 Single-page mode on a phone (GIF, ~3.2 MB)

\n\n![Mobile single-page mode](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/gif/reader-flip-mobile.gif)\n\n

\n\n

🎨 Themes and settings (GIF, ~1.6 MB)

\n\n![Themes and settings](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/gif/settings-themes.gif)\n\n

\n\n## 📸 Screenshots\n\n

🖼️ Show screenshots (13 images, ~24 MB total)

\n\n| | |\n| ------------------------------------------------------------ | ---------------------------------------------------------- |\n| ![Library](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/library.png) | ![Reader](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/reader.png) |\n| ![Theme: Paper](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/theme-paper.png) | ![Theme: Sepia](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/theme-sepia.png) |\n| ![Theme: Night](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/theme-night.png) | ![Theme: Forest](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/theme-forest.png) |\n| ![Theme: Sky](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/theme-sky.png) | ![Settings](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/settings.png) |\n| ![Bookmarks](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/bookmarks.png) | ![Table of contents](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/toc.png) |\n| ![Footnote tooltip](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/footnote-tooltip.png) | ![Footnote target](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/footnote-target.png) |\n| ![Images in a book](https://raw.githubusercontent.com/Hiddenath/book_reader/main/assets/screenshots/images.png) | |\n\n

\n\n## ✨ Features\n\n### Reading\n\n- 📕 **3D book spread** with page-flip animation (CSS 3D)\n- 📱 **Single-page mode** — for tall/portrait screens only the right page is shown automatically\n- 🖱️ **Interactive page turning** — grab the page corner with the mouse or your finger\n- 👆 **Touch controls** — swipe left/right and wide tap zones on the screen edges\n- 🔊 **Volume keys** — page turning inside an Android WebView wrapper (in a regular browser the OS intercepts them)\n- ⌨️ **Navigation**: arrows, spacebar, Home/End, click zones on the sides\n- 📄 **Dynamic layout** — text is split into pages according to screen size, font and margins\n- 📍 **Position saving** — reopening a book returns you to where you left off (anchored to text, not page numbers)\n\n### Narrator (read aloud)\n\n- 🗣️ **Text-to-speech** — the narrator reads the book aloud using the built-in browser voices (Web Speech API, works offline)\n- 📖 **Reads both pages** of the spread, then flips the page with animation and sound — just like manual reading\n- 🎚️ **Stress marks** — a 3.2M-word Russian stress dictionary (RUAccent) marks the stressed vowel of every word, so the voice puts accents correctly («за́мок», not «замо́к»)\n- 🎭 **Human-like pacing** — separate pauses after sentences, paragraphs, chapter titles and poem stanzas; headings are read slower, like an announcer\n- 🧹 **Clean speech** — quotes and markup symbols are not read aloud, dashes become natural pauses\n- ⏯️ **One button** — the FAB button starts/stops narration when a book is open (in the library it still adds books)\n- 📄 **Auto-flip toggle** — optionally stop at the end of each page instead of turning automatically\n\n### Page-flip sounds\n\n- 🔊 **Paper rustle** on every page flip — a random sound from the `sounds/` folder (no repeats in a row)\n- ➕ **Drop-in sounds** — add more MP3/OGG/WAV files into `sounds/`, they are picked up automatically, no code changes\n- 🔈 **Toggle in settings** — sound can be turned off alongside the animation toggle\n\n### Library\n\n- 📚 **Card grid** with covers, title, author and reading progress\n- ➕ **Adding books**: button, Drag & Drop\n- 📂 **Formats**: TXT, EPUB, FB2\n- 🗑️ **Deleting books** with confirmation\n- 💾 **Server-side storage** — books live in the `books/` folder, metadata in `meta.json`\n\n### Bookmarks\n\n- 🔖 **Add/remove bookmarks** with text preview\n- 📑 **Side panel** with the list, click to jump to the location\n- 🎯 **Marker on the book edge** — visual bookmark indicator\n\n### Table of Contents\n\n- 📃 **Chapter navigation** — jump to any chapter from the TOC panel\n\n### Settings\n\n- 🔤 **Font size**, line height, horizontal & vertical margins\n- 🎨 **7 themes**: Paper, Sepia, Night, Forest, Sky, Ember (OLED), Amber (OLED)\n- 🌙 **Immersive mode** — clicking the center hides all panels\n- 🔤 **Hyphenation** toggle\n- 🎞️ **Page-flip animation** and **flip sound** toggles\n- 📄 **Auto-flip during narration** toggle\n\n## 📱 Phone controls\n\n- **Tap the screen edges** — right/left edges flip forward/back (zones widen automatically on touch screens)\n- **Swipe** — swipe left to go forward, right to go back\n- **Volume keys** — in a regular browser the OS intercepts them, so flipping works inside an **Android WebView wrapper**. The wrapper can control the reader in three ways (implementation: `js/reader.js`, `_bindVolumeKeys`):\n\n| Way | How to do it in the wrapper |\n| --------- | ---------------------------------------------------------------------------------------------------------------- |\n| JS bridge | Call`window.BookHavenNative.volumeUp()` / `.volumeDown()` (e.g. via `evaluateJavascript` in `onKeyDown`) |\n| Event | Dispatch`window.dispatchEvent(new Event('volumeup'))` / `('volumedown')` |\n| Key | Forward a`keydown` with `keyCode` 175 (louder) / 174 (quieter) to the WebView |\n\n## 🚀 Quick start\n\n### Docker (recommended)\n\n```bash\ndocker run -d --name bookhaven \\\n -p 8080:8080 -p 8001:8001 \\\n -v bookhaven-books:/app/books \\\n -v bookhaven-data:/app/data \\\n --restart unless-stopped \\\n hiddenath/bookhaven:latest\n```\n\nOpen **http://localhost:8080** — that's it. Books and settings live in named volumes and survive container recreation. Add a book via the UI (button / drag & drop) or:\n\n```bash\ndocker cp \"My book.fb2\" bookhaven:/app/books/\n```\n\n### Local (no Docker)\n\n```bash\n# Start the server (static + API in one file)\npython3 server.py\n\n# Open in browser\nhttp://127.0.0.1:8080\n```\n\nThe server runs two processes in threads:\n\n- **8080** — static files (HTML/CSS/JS)\n- **8001** — API for saving state and books\n\nOptions:\n\n```bash\npython3 server.py # both servers\npython3 server.py --static # static only (8080)\npython3 server.py --api # API only (8001)\npython3 server.py --quiet # no request logging\n```\n\n## 📁 Project structure\n\n```\nbook_reader/\n├── index.html # Entry point, UI markup\n├── book.svg # Logo (library header + favicon)\n├── server.py # Single server: static + API\n├── css/\n│ ├── main.css # Global styles, themes (CSS Custom Properties)\n│ ├── reader.css # 3D reader scene, bookmarks\n│ └── library.css # Library (card grid)\n├── js/\n│ ├── main.js # Initialization, pagination, state, autosave\n│ ├── reader.js # Reader: flip animation, drag, keyboard, volume keys\n│ ├── narrator.js # Narrator: speech engines, pacing, stress marks\n│ ├── sounds.js # Page-flip sounds (random pick from sounds/)\n│ ├── library.js # Library: cards, import, deletion\n│ ├── bookmarks.js # Bookmarks (side panel, marker on the book edge)\n│ ├── notes.js # Footnotes: tooltip, jump to note, \"back\" button\n│ ├── parsers.js # TXT/EPUB parsers (FB2 — server-side)\n│ ├── position.js # Reading anchors (data-block-id)\n│ ├── toc.js # Table of contents\n│ └── storage.js # localStorage + server-side saving\n├── lib/\n│ ├── epub.js # epub.js (downloaded, BSD)\n│ ├── jszip.min.js # JSZip — epub.js dependency\n│ └── stress_dict.json.gz # Russian stress dictionary (3.2M word forms, RUAccent)\n├── sounds/ # Page-flip sounds (MP3/OGG/WAV, picked up automatically)\n├── assets/ # Screenshots and GIF animations for the README\n├── books/ # Book catalog (created automatically)\n│ ├── .fb2 / .txt / .epub # Book file with its original name\n│ └── .meta.json # Metadata next to the book file\n└── data/\n └── state.json # Global settings (created automatically)\n```\n\n## 🔧 How it works\n\n### Pagination\n\nText is split into pages in the browser: a hidden measurer computes the height of each paragraph under the current font settings, then paragraphs are laid out into pages. Each paragraph gets a stable identifier (`data-block-id`) tied to the book and its sequential number — so the reading position does not \"drift\" when settings change.\n\n### Data storage\n\nBooks are stored as **plain files** in `books/` — the original filename is kept, no subfolders. Metadata (progress, bookmarks, covers) is stored in `.meta.json` next to the book.\n\n| What | Where |\n| ----------------------------------- | -------------------------------------- |\n| Books (originals) | `books/.fb2 / .txt / .epub` |\n| Book metadata (progress, bookmarks) | `books/.meta.json` |\n| Global settings | `localStorage` + `data/state.json` |\n\n### API\n\n| Method | Path | Description |\n| ---------- | ---------------------------- | ------------------------------------------ |\n| `GET` | `/books` | List of books (metadata without text) |\n| `POST` | `/books` | Save a book (copies into`books/`) |\n| `GET` | `/books//text` | Book text (FB2 parsed on the fly) |\n| `GET` | `/books//meta` | Book metadata |\n| `POST` | `/books//meta` | Update progress/bookmarks |\n| `GET` | `/books//cover` | Book cover (from FB2``) |\n| `GET` | `/books//image/` | Image from the book body (FB2``) |\n| `DELETE` | `/books/` | Delete a book |\n| `GET` | `/sounds` | List of page-flip sound files |\n| `POST` | `/tts/stress` | Mark up text with stress accents (U+0301) for the narrator |\n\n## 📋 Tech stack\n\n- **Frontend**: vanilla ES2022 JavaScript, CSS3 Custom Properties, CSS 3D transforms\n- **Backend**: Python `http.server` (no dependencies)\n- **Libraries**: epub.js + JSZip (bundled in `/lib/`)\n- **TTS**: Web Speech API (browser voices) + RUAccent stress dictionary (3.2M word forms)\n- **Icons**: inline SVG (Material Design paths)\n\n## 📄 License\n\n**Dual licensing:**\n\n- 🆓 **Personal use — free**: read, install on your devices, modify for\n yourself, share with others for personal use.\n- 💼 **Commercial use — paid license**: selling, embedding into\n commercial products/services, monetized hosting, using the code in\n commercial projects — requires purchasing a license from the author.\n\nApplies to the repository version dated September 1, 2026 and later.\n\nThird-party libraries: epub.js (BSD-3-Clause), JSZip (MIT/GPLv3).\n\n> 📚 **About the books in the screenshots**: the demo uses free preview versions of books from [LitRes](https://www.litres.ru/) (a Russian e-book store) and a public-domain art book. They are shown for demonstration purposes only and are not distributed with the project.\n","has_starred","hub_user","immutable_tags_settings",{"_80":11,"_81":82},"enabled","rules",[83],".*","is_automated","permissions",{"_87":22,"_88":11,"_89":11},"read","write","admin","user","storage_size",290276632,"orgData","recentTags",[96],{"_97":50,"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_56":130,"_131":99,"_132":34,"_133":62,"_44":134,"_135":136,"_137":115,"_138":130,"_139":70,"_140":22},"content_type","creator",9318618,"digest","sha256:b9290fadd9816700a4b5c55ef77f4e00e9269481a8eeda32e672fc992f72b275","full_size",85609548,"id",1294934466,"images",[108,124],{"_109":110,"_100":111,"_112":113,"_114":115,"_116":117,"_118":119,"_120":113,"_121":-5,"_122":103,"_68":70,"_123":-5},"architecture","amd64","sha256:f9c88bebf76b6c82e4dc6c1bfda547ef971966192b41888d9a775e79dadd7920","features","","last_pulled","2026-10-23T11:06:54.047245574Z","last_pushed","2026-09-05T01:51:38.032100332Z","os","linux","os_features","os_version","size","variant",{"_109":125,"_100":126,"_112":113,"_114":127,"_116":128,"_118":119,"_120":113,"_121":-5,"_122":129,"_68":70,"_123":-5},"arm64","sha256:db028e03ac07ac4bbc6a0371a1c4bc4c91fd34b73ac9f05d4763e0f66e090ddf","2026-10-23T11:06:54.00923233Z","2026-09-05T01:51:35.803152996Z",86252158,"2026-09-05T01:51:40.518922Z","last_updater","last_updater_username","media_type","latest","repository",32360921,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_39":155,"_163":164,"_149":174,"_175":11},{"_41":156,"_48":158,"_51":52,"_53":54,"_55":11,"_56":57,"_58":59,"_60":159,"_44":36,"_33":34,"_63":64,"_65":-5,"_66":67,"_68":67,"_69":70,"_71":-5,"_72":73,"_74":75,"_76":11,"_77":34,"_78":160,"_84":11,"_85":162,"_90":34,"_91":92},[157],{"_44":45,"_46":47},[50],[62],{"_80":11,"_81":161},[83],{"_87":22,"_88":11,"_89":11},"tags",{"_165":67,"_166":-5,"_167":-5,"_168":169},"count","next","previous","results",[170],{"_97":50,"_98":99,"_100":101,"_102":103,"_104":105,"_106":171,"_56":130,"_131":99,"_132":34,"_133":62,"_44":134,"_135":136,"_137":115,"_138":130,"_139":70,"_140":22},[172,173],{"_109":110,"_100":111,"_112":113,"_114":115,"_116":117,"_118":119,"_120":113,"_121":-5,"_122":103,"_68":70,"_123":-5},{"_109":125,"_100":126,"_112":113,"_114":127,"_116":128,"_118":119,"_120":113,"_121":-5,"_122":129,"_68":70,"_123":-5},[],"canDeleteTags","actionData","errors"]

Digest	OS/ARCH	Compressed size
f9c88bebf76b	linux/amd64	81.64 MB
db028e03ac07	linux/arm64	82.26 MB

hiddenath/bookhaven

Tags for hiddenath/bookhaven