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

prettier changes

Browse Source
This commit is contained in:
David Maisonave
2024-07-28 15:18:18 -04:00
parent ab7f85a74d
commit 32ae932f8a
2 changed files with 14 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
plugins/RenameFile/README.md
View File

@@ -1,7 +1,5 @@
# RenameFile: Ver 0.4.0 (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
@@ -12,9 +10,8 @@ In addition, the plugin optionally also appends tags and performers to the file
Note: This script is **largely** based on the [Renamer](https://github.com/Serechops/Serechops-Stash/tree/main/plugins/Renamer) script.
### Using RenameFile
- Open a scene (via Stash), and click on the [**Edit**] tab. Populate the [**Title**] field with the desired file name.
- Note: Do **NOT** include the file folder name and do **NOT** include file extension.
- Open a scene (via Stash), and click on the [**Edit**] tab. Populate the [**Title**] field with the desired file name.
- Note: Do **NOT** include the file folder name and do **NOT** include file extension.
- After populating the Title field, click the save button.
- After a few seconds, the file will get renamed and the screen will get updated with the new file name.
- The append tags and perfomers option is disable by default. To enable these options go to the Settings->Plugins->Plugins->[RenameFile] field options, and enable the associated field.
@@ -28,28 +25,27 @@ Note: This script is **largely** based on the [Renamer](https://github.com/Serec
- Define key fields to use to format the file name. This is a comma seperated list, and the list should be in the desired format order. (Default=title,performers,studio,tags)
- For example, if the user wants the performers name before the title, set the performers name first.
- Example:"performers,title,tags".
- This is an example of user adding height:"title,performers,tags,height"
- Here's an example using all of the supported fields: "title,performers,tags,studio,galleries,resolution,width,height,video_codec,frame_rate,date".
- The **resolution** field equals width + height.
- The date field is **not** populated by default unless the user explicitly adds the date value to a scene.
- If **[Key Fields]** is empty, the default value is used. (Default=title,performers,studio,tags)
- This is an example of user adding height:"title,performers,tags,height"
- Here's an example using all of the supported fields: "title,performers,tags,studio,galleries,resolution,width,height,video_codec,frame_rate,date".
- The **resolution** field equals width + height.
- The date field is **not** populated by default unless the user explicitly adds the date value to a scene.
- 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`
`
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:
- `pip install stashapp-tools`
- `pip install pyYAML`
- `pip install requests`
### Installation
- Follow **Requirements** instructions.
- Create a folder named **RenameFile**, in the stash plugin directory (C:\Users\MyUserName\.stash\plugins).
- Download the latest version from the following link: [RenameFile](https://github.com/David-Maisonave/Axter-Stash/tree/main/plugins/RenameFile), and copy the plugin files to folder.(**C:\Users\MyUserName\\.stash\plugins\RenameFile**).
@@ -58,6 +54,6 @@ pip install -r requirements.txt
That's it!!!
### Options
- Main options are accessible in the GUI via Settings->Plugins->Plugins->[RenameFile].
- Advanced options are avialable in the **renamefile_settings.py** file. After making changes, go to http://localhost:9999/settings?tab=plugins, and click [Reload Plugins].