Getting Started

To install or update NickelSeries, download it and copy KoboRoot.tgz to the .kobo folder (you may need to show hidden files).

After a reboot, series and subtitle metadata from sideloaded EPUBs or KEPUBs will be automatically imported with the book.

Features

• Works on EPUB and KEPUB files.
• Compatible with the Calibre Kobo plugin.
• Compatible with Calibre or EPUB3 series metadata (Calibre takes precedence).
• Will not override Nickel if Kobo ends up implementing it.
• Compatible with firmware 3.19.5761+.
• Survives firmware updates.
• Does not modify any system files, single file only.
• Easy to uninstall (either delete it over telnet/ssh or create a file named ns_uninstall in the KOBOeReader partition).
• Metadata appears instantly.
• Will also add subtitle metadata (EPUB3 or a Calibre custom column named #subtitle).

Troubleshooting

• How do I uninstall NickelSeries?
  Create a file named ns_uninstall (without any extension) in the KOBOeReader partition and reboot.
• How do I uninstall NickelSeries manually?
  Connect over Telnet/SSH and delete /usr/local/Kobo/imageformats/libns.so, or perform a full factory reset.
• Series metadata is incorrect or missing for imported books.
  Please report the issue and post a copy of the OPF document from within the EPUB.
• I installed NickelSeries and nothing changed!
  NickelSeries doesn't parse metadata for existing books. To do this, you can use seriesmeta with the argument --no-persist, or you can use the Calibre Kobo Touch Extended plugin.
• The series metadata changes after a reboot or USB connection.
  If you use Calibre or seriesmeta, those will take precedence.
• Will this conflict with Calibre or Kobo-UNCaGED?
  No. For the initial import, NickelSeries prioritizes the calibre:series meta tags. For changes afterwards, NickelSeries doesn't override them.
• My Kobo crashes when I try and import a book.
  This issue is unlikely to occur, but if it does, you can uninstall NickelSeries the usual way (see above).
• Where can I report a bug or get more help?
  See the MobileRead discussion thread, email me at patrick (at) pgaskin (dot) net, or open an issue on GitHub.

Changelog

• v4 (2023-10-13, 0deffca) (download)
  Fix bug in EPUB3 series metadata parsing due to undefined behavior.
• v3 (2020-08-12, a06f1ac) (download)
  Added support for using series metadata without an index.
• v2 (2020-07-24, 3c77ac0) (download)
  Switched to NickelHook, improved metadata parsing, added support for subtitle metadata, fixed parsing books with Unicode filenames.
• v1 (2020-07-19, 8c5d318) (download)
  First stable version, all features implemented.