Obsidian Stats logoObsidian Stats

BookOrbit Sync

by Sam Ashley
5
4
3
2
1
Score: 15/100
Install Code

Description

An Obsidian plugin that can sync your book highlights from BookOrbit.

Reviews

No reviews yet.

Stats

12
stars
224
downloads
1
forks
73
days
50
days
50
days
1
total PRs
1
open PRs
0
closed PRs
0
merged PRs
1
total issues
1
open issues
0
closed issues
29
commits

Latest Version

1.1.1
2 months ago

Changelog

1.1.0 Update Notes

Mobile Sync

The plugin was previously "desktop only", but it now also works on mobile. Please note that this has only been tested on Android though.

Sort by page number on sync

Highlights are now synced by page number rather than by time. Please note: Sorting by page number is only completed within one sync batch. If you had highlighted page 200 and synced it last month, then highlighted and synced page 50 this month, it will still show the page 50 highlight after 200. I will likely add an option to re-sort an entire note later on, but for now I don't want to be editing synced highlights in case of messed up annotations or other irregular movement.

Option to Sync "Read" books with no highlights

Added the option to sync books marked as "Read" in BookOrbit that contain no highlights. I like to use this to add notes to books that I have read and keep a record of them in Obsidian.

Fix "View in BookOrbit" links

The "View in BookOrbit" links on each page didn't work, they should do now.

See all version on GitHub

README file from

Github

License Latest Release Desktop Only

An Obsidian plugin that utilises the fantastic highlight handling of BookOrbit and syncs them to Obsidian. I have taken inspiration from the official Readwise plugin on most functionality, but tweaked for self-hosted BookOrbit users.

Features

  • One-way highlight and annotation sync from BookOrbit to Obsidian.
  • One note per book.
  • Incremental sync for new highlights.
  • Manual and optional automatic sync.
  • Option to add custom frontmatter to all synced notes.
  • Option to pull extra metadata (Highlight time, highlight colour, chapter, etc.).

Requirements

  • The plugin requires the user to have a self-hosted BookOrbit instance.
  • The plugin requires the user to have an account for that server.

Installation

Manual Installation

  1. Download main.js and manifest.json from the latest release.
  2. Create a new folder called bookorbit-sync inside your vault's .obsidian/plugins/ directory.
  3. Copy the downloaded main.js and manifest.json into that new folder
  4. In Obsidian, go to Settings → Community plugins and click Reload plugins.
  5. Find BookOrbit Sync in the list and toggle it on.
  6. Click the settings (cog) icon next to it to configure your BookOrbit server URL and credentials.

The plugin is also available to install from Obsidian Community Plugins here.

Known Limitations

The plugin is currently desktop only as there are bugs on Android that need fixing. This fix will likely be in the next release.

Next Features

  1. Allow the plugin to work on mobile.
  2. Exclude chosen books from syncing.

Privacy & Network Use

This plugin connects to the BookOrbit server URL you provide in settings, using the credentials you enter, to fetch your own highlights, annotations, and book covers. No data is sent to any third party or any server other than the one you configure.

License

This project is licensed under the GNU General Public License v3.0.

Sponsors