chris/Axter-Stash
1
0
Fork 0
forked from Github/Axter-Stash
Code Pull Requests Activity

Update README.md

Browse Source
This commit is contained in:
David Maisonave
2024-09-02 13:44:53 -04:00
parent 54c99a1564 d975ec1751
commit 3449d48ab6
1 changed files with 11 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
plugins/RenameFile/README.md
View File

@@ -1,19 +1,22 @@
# RenameFile: Ver 0.5.1 (By David Maisonave)
RenameFile is a [Stash](https://github.com/stashapp/stash) plugin which performs the following tasks.
- **Rename Scene File Name** (On-The-Fly)
- **Append tag names** to file name
- **Append Performer names** to file name
RenameFile is a [Stash](https://github.com/stashapp/stash) plugin.
Users can rename the file name by editing the **[Title]** field and then click **[Save]**.
- The plugin allows user to rename one scene at a time by editing the **[Title]** field and then clicking **[Save]**.
<img width="270" alt="RenameFileViaTitleUnderEditTab" src="https://github.com/user-attachments/assets/f27d0205-d4ed-44fb-9bb2-5b9a75cba2e0">
<img width="270" alt="RenameFileViaTitle_AfterSaved" src="https://github.com/user-attachments/assets/bf5779ea-77b3-478a-8f72-2dba695db6f0">
The [Title] field is located under the [Edit] tab.
- The [Title] field is located under the [Edit] tab.
- After clicking **[Save]**, the change can be seen in File Explorer momentarily.
- <img width="560" alt="RenameFileViaTitle_AfterSaved_InExplorer" src="https://github.com/user-attachments/assets/60cd807b-dd49-4ac8-9eee-801050e20a2c">
<img width="560" alt="RenameFileViaTitle_AfterSaved_InExplorer" src="https://github.com/user-attachments/assets/60cd807b-dd49-4ac8-9eee-801050e20a2c">
- The plugin can optionally append the following fields if they do not already exist in the file name:
- title, performers, tags, studio, galleries, resolution, width, height, video_codec, frame_rate, date
Optionally, the plugin can also append tags and performers to the file name if the name does not already exist in the original file name.
### RenameFile vs RenameOnUpdate
- Although RenameFile has a similar name to other plugins (RenameOnUpdate, Renamer, etc..), it's main purpose is entirely different.
- The main purpose of RenameFile is to rename one scene at a time, which is the scene being displayed on the web browser. The scene is renamed by using the Title field, which is used to rename the base (stem) of the file name.
- Other plugins with similar names are used for mass renaming (rename all your scenes), and do not edit the base (stem).
### Using RenameFile
- Open a scene (via Stash), and click on the [**Edit**] tab. Populate the [**Title**] field with the desired file name.
@@ -41,12 +44,6 @@ Optionally, the plugin can also append tags and performers to the file name if t
- If **[Key Fields]** is empty, the default value is used. (Default=title,performers,studio,tags)
- There are additional options in renamefile_settings.py, but these options should only be changed by advanced users, and any changes should be tested first with the [Dry-Run] option enabled.
**Note:** On Windows 10/11, the file can not be renamed while it's playing. It will result in following error:
`
Error: [WinError 32] The process cannot access the file because it is being used by another process
`
To avoid this error, refresh the URL before changing the Title field.
### Requirements
- pip install -r requirements.txt
- Or manually install each requirement: