Obsidian Stats logoObsidian Stats

Shiori Bookshelf

by usero2-endofday
5
4
3
2
1
New Plugin
Install Code

Description

This plugin has not been manually reviewed by Obsidian staff. A visual bookshelf to manage, organize, and read your manga, light novels, and ebooks directly within Obsidian, featuring automatic cover extraction and external reader support.

Reviews

No reviews yet.

Stats

stars
downloads
0
forks
0
days
NaN
days
NaN
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

Invalid date

Changelog

See all version on GitHub

README file from

Github

Shiori Bookshelf

Shiori Bookshelf is a powerful Obsidian plugin that transforms your vault into a beautiful, fully-featured digital library. It allows you to organize, browse your PDF, EPUB, and CBZ files natively inside Obsidian, complete with automatic cover extraction and metadata management.

✨ Features

  • Beautiful Bookshelf View:
    • A visually rich, grid-based gallery view displaying your books and series covers natively inside Obsidian.
    • Automatically sorts series by the last updated book.
    • Lazy loading with infinite scroll (loads 50 items at a time for optimal performance).
  • Library Organization:
    • Series Libraries: Automatically group manga, comics, or light novels into a series based on subfolders.
    • Single Libraries: Manage standalone books independently, regardless of folder structure.
  • WebApp Server (Remote Access):
    • Built-in local web server allows you to browse and read your Obsidian library from any web browser, phone, or tablet on your local network.
    • Features a fully responsive mobile-friendly UI, URL routing, advanced filtering, and a built-in remote web reader for all supported formats.
  • WebApp Built-In Readers:
    • Read your files natively without third-party apps!
    • Full support for PDF, EPUB, and CBZ/CBR formats.
    • CBZ reader features infinite-scroll lazy loading with progress tracking, allowing massive files to load instantly.
  • Automated Metadata & AI Integration:
    • Automatically extracts cover images (_cover.jpg) directly from your EPUB, CBZ, and PDF files.
    • Gemini AI Auto-Fill: Connect your free Google Gemini API key to automatically fetch and fill rich metadata for your series (including Summary, Genres, Tags, Writers, Publisher, and Release Year) with a single click.
  • Advanced Search & Filtering:
    • Search your library by Title, Writer, or File Name.
    • Filter by reading status (All, Read, Unread, Reading).
    • Use the Advance Filter to drill down by Libraries, specific Genres, or Tags.
  • Context Menu Integration:
    • Force Rename: Bypass Obsidian's restrictive character limits to rename files using characters like #, ^, [, ], |. Automatically syncs the new name to the companion metadata and cover files.
    • Scan: Manually trigger cover extraction for all books inside a folder.
    • Add to Libraries: Quickly add folders to your Series or Single libraries via right-click.
  • Clean File Explorer:
    • Options to automatically hide the extracted _cover.jpg and metadata .md files from your Obsidian file explorer to keep your workspace completely clutter-free.

🚀 Installation

Note: This plugin is currently in development and can be installed manually.

  1. Download the latest release from the GitHub repository.
  2. Extract the contents (main.js, manifest.json, styles.css) into your Obsidian vault's plugin directory: [Vault]/.obsidian/plugins/obsidian-plugins-shiori-bookshelf/.
  3. Open Obsidian Settings -> Community Plugins.
  4. Refresh the plugin list and enable Shiori Bookshelf.

📖 Documentation & Guides

For detailed, step-by-step instructions on how to use specific features, please refer to the following guides:

📦 Release Notes

v1.0.1

  • File Size in List View: The Bookshelf List view now displays the file size next to the file extension.
  • Remember View State: Your preferred view mode (Thumbnail, List, Detail, etc.), sort order, and filter settings are now automatically saved and remembered across sessions.
  • ✨ Gemini Auto Fill: Added an "Auto Fill" button to the Edit Metadata window. You can now automatically fetch and fill series metadata (including Japanese/English/Romaji aliases, summary, writers, publisher, genres, tags, and age rating) using Google's Gemini AI.
  • Gemini Settings: Added settings for "Gemini API Key" and "Gemini Model" to support the new Auto Fill feature.

v1.0.2

  • Unified Context Menu: The right-click context menu (Open in new window, Force Rename, Delete, etc.) is now available across all view modes (Card, Thumbnail, List, and Detail View).
  • Advance Filters: Added a new "Advance Filter" toggle in the home bookshelf to easily show/hide filter categories.
  • Library Filtering: Added the ability to filter series by "Libraries" (your setup folders) alongside Genres and Tags.
  • Improved Filter Organization: Filter sections are now reordered to Libraries, Genres, and Tags, and are expanded by default when you click the Advance Filter button.
  • Reset Filters Button: Added a convenient "Reset Filters" button to instantly clear all selected filters across all categories.
  • Thumbnail Zoom: Added zoom controls (-, reset, +) for the Thumbnail view, allowing you to easily resize book covers.

v1.0.3

  • Series Context Menu: Added a right-click context menu to Series cards, bringing feature parity with book cards. You can now easily perform actions like Open in new window, Copy path, Show in system explorer, Reveal in navigation, Regenerate Cover (for all books in the series), Open Metadata file, Force Rename, and Delete directly from the series folder.
  • Fixed How To Tab: Fixed an issue where the "How To" instructions in the settings tab would disappear when the plugin was downloaded/installed via the community plugins directory. Instructions are now bundled directly within the plugin.

v1.0.4

  • WebApp Advance Filters: Brought the "Advance Filter" functionality to the WebApp! You can now easily filter your entire library by Libraries, Genres, and Tags directly from your browser, complete with a convenient Reset Filters button.
  • WebApp Series Detail View: Overhauled the WebApp series view. When clicking into a series, it now beautifully displays full series details including the cover image, writers, publisher, release year, status, genres, tags, and summary, matching the rich experience of the Obsidian app.
  • WebApp URL Routing: Implemented URL routing in the WebApp. Navigating into a series now updates the URL (e.g., /?series=...), allowing you to bookmark, share direct links to specific series, and use your browser's back/forward buttons seamlessly.
  • WebApp EPUB Reader: Added a built-in EPUB reader to the WebApp, allowing you to read .epub files seamlessly directly in your browser.
  • WebApp CBZ Lazy Loading: Optimized the CBZ reader to lazy-load images as you scroll. This drastically improves initial load times and memory usage for large CBZ files (e.g., 500MB+) and includes a visual progress indicator.
  • WebApp Reader Navigation: Fixed an issue where using the browser's back button while in the reader (PDF, CBZ, EPUB) would unexpectedly navigate away from the series view instead of just closing the reader.
  • WebApp Responsive Header: Improved the layout of the WebApp header on small screens (mobile/tablet), ensuring the title, search inputs, and Advance Filter button stack gracefully without overlapping.
  • Server Access Links: Added dynamic server access links in the plugin settings (under the Web Server tab) that display your localhost and local network IP addresses, making it easy to open the WebApp on other devices like phones or tablets.

v1.0.5

  • Scan Progress Indicator: Added a visual progress notice when scanning folders or series for missing covers. It now clearly shows how many books have been processed (e.g. Scanning 20/400 books... Extracted: 5) and updates in real-time, preventing the app from hanging during large scans.
  • Force Regenerate Cover: Added a new "Force Regenerate Cover" option to both Book and Series right-click context menus. This allows you to forcibly extract and overwrite covers even if a _cover.jpg already exists.
  • Smart Cover Extraction: The regular cover extraction logic is now smarter! If you trigger a "Regenerate Cover" and a cover image already exists in the folder, it will instantly link it to the book's metadata without redundantly re-extracting it from the archive, saving significant time.
  • Faster PDF Cover Extraction: Massively improved the performance of extracting covers from PDF files. Instead of loading the entire PDF file into memory, Shiori Bookshelf now efficiently streams only the required data chunks needed to render the very first page via HTTP Range Requests, saving a huge amount of memory and time.

v1.0.6 (Hotfix)

  • API Compatibility Fix: Resolved a critical bug where users on Obsidian versions prior to 1.4.0 would experience silent failures during cover extraction due to the missing processFrontMatter API. Added robust fallbacks for legacy versions.
  • Progress UI Fix: Fixed a crash caused by the new progress notice on older Obsidian versions lacking the setMessage function.
  • PDF Extraction Fix: Fixed an issue where PDF cover extraction would fail and return 0 covers if the user had not explicitly opened a PDF document in their current session, by dynamically pre-loading Obsidian's built-in PDF.js library.

v1.0.7

  • PDF Extraction Fix: Fixed a bug where PDF cover extraction would fail if loadPdfJs was not globally available. The plugin now correctly imports the required API, ensuring reliable background PDF scanning.
  • Series Scan Fix: Resolved a silent crash that occurred when triggering a manual "Scan" or "Regenerate Cover" from the Series card context menu.
  • Force Regenerate UI Fix: Ensured the bookshelf UI remains fully responsive during long scan operations, and that "Force Regenerate Cover" directly updates the visual DOM without requiring a full page reload.

❤️ Support & Donate

If this plugin has improved your Obsidian workflow, saved you time, or you just want to support its continued development, please consider donating!

Your support is incredibly appreciated, helps fix bugs, and keeps this project alive and growing. 🙏

https://buymeacoffee.com/endofday

Built with ❤️ for the Obsidian Community

Sponsors