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-01 13:24:05 -04:00
committed by GitHub
parent bd5b754389
commit 09f7068197
1 changed files with 11 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
plugins/RenameFile/README.md
View File

@@ -1,24 +1,24 @@
# RenameFile: Ver 0.5.0 (By David Maisonave) # RenameFile: Ver 0.5.0 (By David Maisonave)
RenameFile is a [Stash](https://github.com/stashapp/stash) plugin. RenameFile is a [Stash](https://github.com/stashapp/stash) plugin.
The plugin allows user to rename one scene at a time by editing the **[Title]** field and then clicking **[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="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"> <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.
<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. - The plugin can optionally append the following fields if they do not already exist in the file name.
- tags - tags
- performers - performers
- studio - studio
- galleries - galleries
- resolution - resolution
- video_codec - video_codec
- frame_rate - frame_rate
- date - date
### RenameFile vs RenameOnUpdate ### RenameFile vs RenameOnUpdate
- Although RenameFile has a similar name to other plugins (RenameOnUpdate, Renamer, etc..), it's main purpose is entirely different. - Although RenameFile has a similar name to other plugins (RenameOnUpdate, Renamer, etc..), it's main purpose is entirely different.
@@ -51,12 +51,6 @@ The plugin can optionally append the following fields if they do not already exi
- If **[Key Fields]** is empty, the default value is used. (Default=title,performers,studio,tags) - 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. - 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 ### Requirements
- pip install -r requirements.txt - pip install -r requirements.txt
- Or manually install each requirement: - Or manually install each requirement: