Directives
Directives are information you add to your files or folders which will help oboku understand what they are and how they should be treated.
Use case:
For example, let's say you have a solo leveling Vol.1.cbz book on yout drive. By default oboku will assume it's a manga and will open it as horizontal scrolling with a reading direction from right to left. This is because there are some default behavior oboku try to assume based on the extension of your book. Now, because you know it's a webtoon you want oboku to display it automatically vertically with a scrolling reading mode. To solve this you can use a directive directly on your file such as: solo leveling Vol.1 [oboku~webtoon].cbz.
Directives can be placed on files but also folder (collections). Read the details of each directives to see what they do.
Directives are very similar to plex naming convention as an example https://support.plex.tv/articles/naming-and-organizing-your-tv-show-files/.
Due to some current limitation, you may need to re-download a book for some directives to be active. For example if you download a .cbz file which is read from left to right, it will open as rtl since it's the default behavior. To fix it you need to add the ltr directive. However you will need to remove and re-download the local file to make the change effectives.
tags
tagsSpecify list of tags for the given file or folder. If the directive is on the folder, the tags will be added to every sub files.
webtoon
webtoonSpecify a book as webtoon content. Oboku will display the book vertically with a free scrolling experience. This can also be set on a manifest level and would be the recommended way of doing it.
metadata-ignore~file
metadata-ignore~fileFiles only
Tells oboku to not use any information from the file itself to build the metadata. It can be useful if for exemple you don't want the cover to be the first image from the file or if the epub file is not good enough for you and contain invalid information.
Remember that the file source metadata takes priority over other sources such as google API but not the user source.
metadata-title~{value}
metadata-title~{value}Collections only
Tells oboku to use this title instead of the folder name when looking for metadata. Sometimes it's easier to match some series matadata by using different title. Something you don't necessarily want as folder name but just very specific for metadata (eg: japanese title for manga).
no_collection
no_collectionOnly usable on folders. Use this directive if you want to prevent the folder to be treated as collection. This is usefull if you use a data source that contains lot of sub folder and you don't necessarely want to have a collection for each folder (default behavior).
When using no_collection on a folder, oboku will then use the default behavior for all children which means every folder directly under this folder will be treated as collection. Use this directive again if you need to ignore deeper folder.
ignore
ignoreWill ignore the item or folder and its sub folders/items
direction
directionOnly usable on files. Override the default direction for a given book. By default oboku will use several strategies to detect the reading direction which are applied by order of priority as follow:
If the file is an
.epubit will use metadata directionOtherwise use directive if it exist
Otherwise if the file is a
.cbzit will be rtl. (cbz is most commonly used for manga)Finally if it's none of the cases above it will use ltr
isbn
isbnOnly usable on files. Tells oboku to use this isbn to extract metadata. This is a very useful directive if your content does not contains much information for oboku to get metadata from. By using this directive oboku will not look at the file but rather directly get metadata from external API based on the ISBN. This use case is useful if:
Your
.epubfile is incompleteYour are using simple image archive such as
.cbz,.cbr, ...Your file is above the recommended size of ~500mb
Last updated