Update captions documentation (#5967)

* Update captions documentation to clarify file location and naming conventions
* Clarify naming convention
This commit is contained in:
DogmaDragon 2025-06-26 00:33:55 +03:00 committed by GitHub
parent 704041d5e0
commit 27bc6c8fca
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,15 +2,17 @@
Stash supports captioning with SRT and VTT files. Stash supports captioning with SRT and VTT files.
These files need to be named as follows: Captions will only be detected if they are located in the same folder as the corresponding scene file.
Ensure the caption files follow these naming conventions:
## Scene ## Scene
- {scene_name}.{language_code}.ext - {scene_file_name}.{language_code}.ext
- {scene_name}.ext - {scene_file_name}.ext
Where `{language_code}` is defined by the [ISO-6399-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (2 letters) standard and `ext` is the file extension. Captions files without a language code will be labeled as Unknown in the video player but will work fine. Where `{language_code}` is defined by the [ISO-6399-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (2 letters) standard and `ext` is the file extension. Captions files without a language code will be labeled as Unknown in the video player but will work fine.
Scenes with captions can be filtered with the `captions` criterion. Scenes with captions can be filtered with the `captions` criterion.
**Note:** If the caption file was added after the scene was initially added during scan you will need to run a Selective Scan task for it to show up. **Note:** If the caption file was added after the scene was initially added during scan, you will need to run a Selective Scan task for it to show up.