forked from Github/Axter-Stash
Changes via prettier
This commit is contained in:
David Maisonave
@@ -1,19 +1,22 @@
|
||||
# ChangeFileMonitor: Ver 0.1.0 (By David Maisonave)
|
||||
|
||||
ChangeFileMonitor is a [Stash](https://github.com/stashapp/stash) plugin which updates Stash if any changes occurs in the Stash library paths.
|
||||
|
||||
### Using ChangeFileMonitor
|
||||
|
||||
- To start monitoring file changes, go to **Stash->Settings->Task->[Plugin Tasks]->ChangeFileMonitor**, and click on the [Start Library Monitor] button.
|
||||
- 
|
||||
- To stop this task, go to **Stash->Settings->Task->[Task Queue]**, and click on the **[x]**.
|
||||
- 
|
||||
|
||||
|
||||
### Requirements
|
||||
|
||||
`pip install stashapp-tools`
|
||||
`pip install pyYAML`
|
||||
`pip install watchdog`
|
||||
|
||||
### Installation
|
||||
|
||||
- Follow **Requirements** instructions.
|
||||
- In the stash plugin directory (C:\Users\MyUserName\.stash\plugins), create a folder named **ChangeFileMonitor**.
|
||||
- Copy all the plugin files to this folder.(**C:\Users\MyUserName\\.stash\plugins\ChangeFileMonitor**).
|
||||
@@ -22,6 +25,5 @@ ChangeFileMonitor is a [Stash](https://github.com/stashapp/stash) plugin which u
|
||||
That's it!!!
|
||||
|
||||
### Options
|
||||
|
||||
- All options are accessible in the GUI via Settings->Plugins->Plugins->[ChangeFileMonitor].
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: ChangeFileMonitor
|
||||
description: Monitors the Stash library folders, and updates Stash if any changes occurs in the Stash library paths.
|
||||
description: Monitors the Stash library folders, and updates Stash if any changes occurs in the Stash library paths.
|
||||
version: 0.1.0
|
||||
url: https://github.com/David-Maisonave/Axter-Stash/tree/main/plugins/ChangeFileMonitor
|
||||
settings:
|
||||
@@ -14,7 +14,7 @@ settings:
|
||||
scanModified:
|
||||
displayName: Scan Modifications
|
||||
description: Enable to monitor changes in file system for modification flag. This option is NOT needed for Windows, because on Windows changes are triggered via CREATE, DELETE, and MOVE flags. Other OS may differ.
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
zgraphqlEndpoint:
|
||||
displayName: GraphQL Endpoint
|
||||
description: (Default=http://localhost:9999/graphql). Update with your endpoint, or leave blank to use default.
|
||||
@@ -22,11 +22,11 @@ settings:
|
||||
zzdebugTracing:
|
||||
displayName: Debug Tracing
|
||||
description: (Default=false) [***For Advanced Users***] Enable debug tracing. When enabled, additional tracing logging is added to Stash\plugins\ChangeFileMonitor\changefilemonitor.log
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
zzdryRun:
|
||||
displayName: Dry Run
|
||||
description: Enable to run script in [Dry Run] mode. In this mode, Stash does NOT call meta_scan, and only logs the action it would have taken.
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
exec:
|
||||
- python
|
||||
- "{pluginDir}/changefilemonitor.py"
|
||||
@@ -35,4 +35,4 @@ tasks:
|
||||
- name: Start Library Monitor
|
||||
description: Monitors paths in Stash library for media file changes, and updates Stash.
|
||||
defaultArgs:
|
||||
mode: start_library_monitor
|
||||
mode: start_library_monitor
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# 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
|
||||
@@ -10,8 +12,9 @@ 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.
|
||||
@@ -25,27 +28,28 @@ 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**).
|
||||
@@ -54,6 +58,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].
|
||||
|
||||
|
||||
@@ -1,28 +1,28 @@
|
||||
name: RenameFile
|
||||
description: Renames video (scene) file names when the user edits the [Title] field located in the scene [Edit] tab.
|
||||
description: Renames video (scene) file names when the user edits the [Title] field located in the scene [Edit] tab.
|
||||
version: 0.4.0
|
||||
url: https://github.com/David-Maisonave/Axter-Stash/tree/main/plugins/RenameFile
|
||||
settings:
|
||||
performerAppend:
|
||||
displayName: Append Performers
|
||||
description: Enable to append performers name to file name when renaming a file. Requires performers to be included in [Key Fields] list, which by default it is included.
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
studioAppend:
|
||||
displayName: Append Studio
|
||||
description: Enable to append studio name to file name when renaming a file. Requires studio to be included in [Key Fields] list, which by default it is included.
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
tagAppend:
|
||||
displayName: Append Tags
|
||||
description: Enable to append tag names to file name when renaming a file. Requires tags to be included in [Key Fields] list, which by default it is included.
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
z_keyFIeldsIncludeInFileName: # Prefixing z_ to variable names so that the GUI will place these fields after above fields (alphabatically listed)
|
||||
displayName: Include Existing Key Field
|
||||
description: Enable to append performer, tags, studios, & galleries even if name already exists in the original file name.
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
zafileRenameViaMove:
|
||||
displayName: Rename Using Move
|
||||
description: Enable to have file moved when renaming file.
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
zfieldKeyList:
|
||||
displayName: Key Fields
|
||||
description: '(Default=title,performers,studio,tags) 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. 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".'
|
||||
@@ -50,11 +50,11 @@ settings:
|
||||
zzdebugTracing:
|
||||
displayName: Debug Tracing
|
||||
description: (Default=false) [***For Advanced Users***] Enable debug tracing. When enabled, additional tracing logging is added to Stash\plugins\RenameFile\renamefile.log
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
zzdryRun:
|
||||
displayName: Dry Run
|
||||
description: Enable to run script in [Dry Run] mode. In dry run mode, files are NOT renamed, and only logging is performed. Use the logging to determine if rename will occur as expected. This should always be enabled on the first run after renamefile_settings.py has been modified.
|
||||
type: BOOLEAN
|
||||
type: BOOLEAN
|
||||
exec:
|
||||
- python
|
||||
- "{pluginDir}/renamefile.py"
|
||||
@@ -68,4 +68,4 @@ tasks:
|
||||
- name: Rename Last Scene
|
||||
description: Renames file of last updated scene.
|
||||
defaultArgs:
|
||||
mode: rename_files_task
|
||||
mode: rename_files_task
|
||||
|
||||
Reference in New Issue
Block a user