One-Shots

A one-shot is a series that contains a single book. Not all series only containing a single book are considered one-shots, though. If you want Stump to recognize and manage one-shots, it requires a specific library configuration.

How to Configure One-Shots

When creating a library, or when editing an existing one, enablement of one-shot features is determined by whether the Oneshots directory option is set. If it is set to a value, Stump will treat any book in that directory as a one-shot series. If it is not set, one-shots will not be recognized or managed by Stump for that library.

Choosing a One-Shot Directory

This is entirely up to you, Stump supports arbitrary names for flexibility. A few things to keep in mind when choosing a directory name or structure:

• It does not need to be named _oneshots, that is just a fairly-common convention
• It should be a directory name, not a path to a directory
• At any level of a library, if a directory exists with the configured name then it will be treated as a oneshots directory
• Nested books will not be ingested during a scan unless their direct parent is a oneshots directory

Example Library Structure

Let's take the following structure of a hypothetical Indie library as an example:

In this example, the one-shots directory is named _oneshots and is a direct subdirectory of the library root. There is also a nested _oneshots directory, which will be accounted for.

Stump will recognize the three books in the top-level _oneshots directory as one-shots, will ignore the Nested Folder and any books within it, and will also recognize the book in the nested _oneshots directory as a one-shot. The books in the The Last Day of Rain (Claudia Matosa) series will also not be recognized as one-shots, since they are not in the _oneshots directory, but will be treated as a normal series. To visualize this for how Stump will treat the library, it would look something like:

/path/to/my/Indie
├── The Last Day of Rain (Claudia Matosa)
│   ├── Chapter 1.cbz
│   ├── Chapter 2.cbz
│   ├── Chapter 3.cbz
│   └── Chapter 4.cbz
└── _oneshots
    ├── Cry Wolf Girl (Ariel Slamet Ries).pdf
    ├── Skin Deep (Flo Woolley).pdf
    ├── The Chromatic Fantasy (H.A.).pdf
    └── This book will not be ignored.cbz

When configuring this library, I would set the path to /path/to/my/Indie as the library root, and _oneshots as the one-shots directory. Stump will check any subdirectory of the library root for a directory named _oneshots, and will combine all books in those directories into one-shot series.

Notable One-Shot Behavior

• When browsing a library's series, one-shot entries will link directly to the corresponding book, rather than a series overview page
• When a library has one-shots enabled, a One-shots tab will become available in the web app's library view

Changing the One-Shots Directory

If you change the one-shots directory for a library that already has one-shots, there are a few things to keep in mind:

• Stump assumes that by the time you change the directory, the books in the old one-shots directory have been moved to the new one-shots directory. If they have not, a scan of the library will likely result in a non-one-shot series being created for the books in the old one-shots directory
• Similarly, if you remove the one-shots directory entirely, effectively disabling one-shot handling for that library, any books that were previously recognized as one-shots will be grouped into a new non-one-shot series

Enabling One-Shots on an Existing Library

If you enable oneshots on an existing library that has books/series which would be recognized as one-shots, Stump will attempt to migrate them. The migration process is as follows:

1. The scanner will recognize existing series and books which match the updated oneshots configuration and track them for migration
2. Each book in the list of aforementioned series will be updated to be an individual oneshot series
3. The now-migrated non-oneshot series will be deleted

If you disable oneshots on a library that previously had them enabled, the migration process is exactly inverted. Each one-shot series will have its single book moved into a new non-oneshot series, and the one-shot series will be deleted.