Skip to content

Commit 37a749d

Browse files
Update README.md
1 parent 69cc412 commit 37a749d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

plugins/RenameFile/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,23 @@ That's it!!!
7777

7878
- Main options are accessible in the GUI via Settings->Plugins->Plugins->[RenameFile].
7979
- Advanced options are available in the **renamefile_settings.py** file. After making changes, go to http://localhost:9999/settings?tab=plugins, and click [Reload Plugins].
80+
- **rename_associated_files_enable** - (Default=True). When value set to true, will enable feature for associated_files_to_rename. See **associated_files_to_rename**.
81+
- **associated_files_to_rename** - This field is a list of file extension that are associated with the video file, and that are renamed when the video file is renamed. Requires **rename_associated_files_enable** to be True. User should add or remove extensions from this list for their particular requirements.
82+
- By default, the following extensions are set to this list:
83+
- **Funscript**: A file format that is the standard format for scripting interactive devices by syncing them up to a video.
84+
- **SRT**: SubRip Text -> A widely used, simple text file format that displays caption text with timecodes
85+
- **VTT**: WebVTT -> A text-based format that is part of the HTML5 standard
86+
- **SCC**: Scenarist Closed Caption -> A format used by broadcast and digital media producers for TV and movies.
87+
- **TTML**: Timed Text Markup Language
88+
- **DFXP**: Distribution Format Exchange Profile
89+
- **LRC**: A computer file format that synchronizes song lyrics with an audio file, such as MP3, AAC, or MIDI.
90+
- **CAP**: Primarily used for Japanese subtitles
91+
- **SAMI**: Synchronized Accessible Media Interchange -> A Microsoft accessibility initiative released in the summer of 1998.
92+
- **STL**: Spruce Subtitle File -> Text file for Apple's DVD Studio Pro
93+
- **MCC**: MacCaption
94+
- **INFO**: A ".info file" is a configuration or metadata file with different meanings depending on the context.
95+
- **TXT**: A plain text file containing information about the associated video file.
96+
- **XML**: Extensible Markup Language -> A text-based file format used for storing and transporting data for the associated video file. It is designed to be both human-readable and machine-readable.
8097
- **handleExe** - Populate this field in order to allow RenameFile plugin to close all open file handles.
8198
- In Windows, a file can't be renamed if the file is opened by another process. In other words, if a file is being played by Stash or any other video player, the RenameFile plugin will get an access denied error when trying to rename the file.
8299
- As a workaround, the 'handleExe' field can be populated with the full path to handle.exe or handle64.exe. (See requirements for download link)

0 commit comments

Comments
 (0)