admin/sublogue
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README tweaks

Browse Source
This commit is contained in:
ponzischeme89
2026-01-17 23:47:52 +13:00
parent dc3dfc06fe
commit 5835a5433f
1 changed files with 29 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+29 -38
View File
@@ -1,25 +1,24 @@
# Sublogue <div align="center">
Sublogue is a lightweight tool for adding plot summaries and metadata to subtitle files. <img src="https://github.com/ponzischeme89/Sublogue/blob/master/docs/sublogue_logo.png" height="256" width="256">
It takes an existing .srt, pulls data from OMDb, TMDb, and TVMaze, and inserts a short plot block at the start of the file — without altering any existing timings or dialogue. <h4>Your subtitles deserve metadata. Sublogue adds it.</h4>
If you’ve ever opened a movie or episode and thought “wait… what was this again?”, Sublogue quietly solves that. </div>
## Features Sublogue is a lightweight open-source tool for enriching SRT files. Pull metadata from OMDb, TMDB, or TVMaze and automatically append plot summaries, runtimes, directors, and cast details to the start or end of your subtitles.
- Inserts a plot summary at the beginning of an existing `.srt` ## Core Features
- Automatically fetches metadata (OMDb, TMDb, TVMaze fallback) - Insert plot summaries into existing `.srt` files without shifting timings
- Never alters existing dialogue timing - Fetch metadata from OMDb, TMDb, and TVMaze
- Handles long plots without breaking readability - Add runtime, director, cast, and ratings to subtitle headers
- Clean web UI (Svelte + Vite) - Preserve original dialogue and timing with safe insertion logic
- Fast Python backend (Flask + aiohttp) - Clean, fast web UI for scanning and batch processing
- Docker image available through GHCR - Docker-first deployment with persistent storage
## Deployment ## Getting started
<details> ### Docker
<summary>Docker Compose</summary>
Create `data/` and `media/` folders next to the compose file, then run: Create `data/` and `media/` folders next to the compose file, then run:
@@ -41,46 +40,45 @@ services:
- "5000:5000" - "5000:5000"
``` ```
Then start it with: Start the stack:
```bash ```bash
docker compose up -d docker compose up -d
``` ```
</details>
<details> Open `http://localhost:5000`.
<summary>Unraid</summary>
Sublogue includes an Unraid template at `unraid-sublogue.xml`. Import it in Unraid's Docker UI, then map: ### Unraid
Use the included template at `unraid-sublogue.xml`.
- `/mnt/user/appdata/sublogue` -> `/config` - `/mnt/user/appdata/sublogue` -> `/config`
- `/mnt/user/appdata/sublogue/media` -> `/media` - `/mnt/user/appdata/sublogue/media` -> `/media`
Start the container and open `http://<UNRAID-IP>:5000`. Start the container and open `http://<UNRAID-IP>:5000`.
</details>
<details> ### Komodo
<summary>Komodo</summary>
Create a new stack in Komodo and paste a template like this (example format below): Create a new stack and paste a Komodo template like this:
```yaml ```yaml
version: "3.9" version: "3.9"
services: services:
shelfarr: sublogue:
image: ghcr.io/ponzischeme89/sublogue:latest image: ponzischeme89/sublogue:latest
container_name: sublogue container_name: sublogue
ports: ports:
- "5055:5055" - "5000:5000"
environment: environment:
- TZ=Pacific/Auckland - TZ=Etc/UTC
- PORT=5055 - PUID=1000
- PGID=1000
volumes: volumes:
- /volume1/Docker/sublogue/data:/data - /volume1/Docker/sublogue/data:/config
- /share/subtitles:/audiobooks - /volume1/Media:/media
restart: unless-stopped restart: unless-stopped
@@ -91,10 +89,3 @@ networks:
npm_network: npm_network:
external: true external: true
``` ```
</details>
## Acknowledgements
- Svelte for the frontend UI.
- Flask for the backend API.
- asyncio for async metadata fetching.