Your First Library¶
This tutorial walks you through adding your first watch folder and seeing your media appear in the Dashboard. By the end, you will understand the journey a file takes from your hard drive to the Library, and you will know how to read the status of each item.
Prerequisites: Tuvima Library is running (Engine and Dashboard both started). If not, see Getting Started first.
Step 1 — Open Settings and add a watch folder¶
In the Dashboard, click the gear icon in the left dock to open Settings, then select Library Folders from the sidebar.
Click Add Folder.
You will be asked for:
- Folder path — the full path to the folder on your machine. For example:
/media/booksorD:\Media\Movies. - Category — what kind of media lives here. Choose from: Books, TV, Movies, Music, Comics, or Podcasts. This tells the Engine what to expect and which providers to contact for enrichment.
- Media types — the specific file types to watch for. The Engine suggests sensible defaults based on your category (for example, EPUB and PDF for Books, MKV and MP4 for Movies), but you can adjust these.
Click Save. The Engine immediately begins watching this folder.
Tip: You can add as many folders as you like — one per category, or several folders for the same category. Each folder is watched independently.
Step 2 — What happens when a file appears¶
The moment the Engine detects a new file in a watched folder, it starts a pipeline. Here is the journey every file takes:
Settle¶
The Engine waits a few seconds after a file appears before touching it. This prevents it from processing a file that is still being copied or downloaded. Once the file size stops changing, the Engine considers it settled.
Fingerprint¶
The Engine computes a unique identifier (a SHA-256 fingerprint) for the file. This fingerprint is the file's permanent identity in the Library. If you later rename the file or move it to a different folder, the Engine will recognise it as the same file.
Scan¶
The Engine opens the file and reads the information embedded inside it — title, author, year, cover art, series name, and so on. For books, this means reading the EPUB metadata. For video files, it reads the embedded tags. The quality of this step depends on how well-tagged your files are.
Identify¶
The Engine compares what it found in the file against its knowledge of known works. It scores possible matches and selects the best one. If confidence is high enough (at least 85%), the file moves forward. If not, it is flagged for your review.
Stage¶
The file is registered in a staging area while enrichment runs. It has an identity but is not yet fully enriched.
Hydrate¶
Two rounds of enrichment happen automatically:
Stage 1 — Retail providers: The Engine contacts services like Apple Books, Google Books, and TMDB to gather cover art, descriptions, ratings, and bridge identifiers (such as ISBN or TMDB ID).
Stage 2 — Wikidata: Using the bridge identifiers from Stage 1, the Engine contacts Wikidata to fetch the canonical version of the metadata — the authoritative title, author, director, series information, and publication year. Wikidata is the Engine's source of truth for all structured data.
Promote¶
Once enrichment is complete and confidence is sufficient, the file is promoted to your organised Library. It appears in the Vault and on the Dashboard's browse pages.
Step 3 — Watch your files appear in the Vault¶
Click Vault in the left dock. This is the command centre for everything in your Library.
You will see your files appearing as the pipeline processes them. Each row shows:
- Thumbnail — the cover art (or a placeholder while it is being fetched)
- Title and creator — the best available title and author/director
- Universe — the franchise or creative world this item belongs to (if known)
- Pipeline status — small dots showing which pipeline stages are complete (hover over them for detail)
- Status pill — the current state of this item
New files often appear first with a Provisional status, then update to Verified once enrichment completes. This can take anywhere from a few seconds to a few minutes, depending on your internet connection and how many files you added at once.
The Vault updates in real time — you do not need to refresh the page.
Step 4 — Understanding status indicators¶
Every item in the Vault has a status pill that tells you where it stands.
| Status | What it means |
|---|---|
| Verified | The Engine is confident about this item's identity. It has been matched against Wikidata and enriched with canonical metadata. |
| Provisional | The Engine could not find a Wikidata match. The file's own metadata is being used as the authority. The item is visible in your Library and usable, but metadata may be incomplete or approximate. |
| Needs Review | Something went wrong or the Engine is unsure and wants your input. See below. |
| Quarantined | The file has a problem (corrupt, unreadable, or a type mismatch) and has been set aside. |
| Pending | The item is still moving through the pipeline. |
Step 5 — Resolving "Needs Review" items¶
A Needs Review status means the Engine ran into a situation it could not resolve on its own. Common reasons include:
- Two or more Wikidata entries matched equally well and the Engine could not decide between them
- The file metadata contained conflicting information
- The media type could not be determined automatically
- The retail provider returned no results and Wikidata found nothing with sufficient confidence
To resolve a Needs Review item:
- Click the item's row in the Vault to open the Detail Drawer on the right.
- Scroll to the Pipeline section.
- Look at the Retail and Wikidata stage entries. Each shows the candidates the Engine found, along with match scores.
- Pick the correct candidate, or use the manual search to find the right one.
- If nothing matches (for example, an obscure self-published title), click Add Provisional — this pre-fills a form with the file's own metadata for you to correct and confirm.
Once you resolve an item, the Engine re-runs enrichment with your input. The status updates automatically.
Items that could not be matched are not hidden. They are promoted to your Library as Provisional items and pinned at the top of the Vault's "All Media" view with an amber highlight so they are easy to find.
Step 6 — Browse your Library¶
Once files are promoted, they appear on the Home page and on the media lane pages (Books, TV, Movies, and so on).
The Home page surfaces personalised swimlanes — recently added items, things the Engine thinks you might like, and smart groupings based on genre, mood, or creator.
The media lane pages (accessible from the left dock) show everything in a given category, organised into swimlanes by Universe, series, genre, or whatever grouping makes sense for that media type.
Click any item to see its detail page, or return to the Vault to manage your collection.
What to do next¶
- Add more watch folders in Settings → Library Folders.
- If you have items stuck in Needs Review, work through them in the Vault.
- Explore the Settings → Providers screen to configure which external services the Engine uses for enrichment.
- Read How File Ingestion Works for a deeper explanation of the decisions the Engine makes along the way.