From c076a05eaed6eed0cc50dfed7783c8720573343a Mon Sep 17 00:00:00 2001 From: David Maisonave <47364845+David-Maisonave@users.noreply.github.com> Date: Sun, 1 Sep 2024 13:07:58 -0400 Subject: [PATCH 1/4] Update README.md --- plugins/RenameFile/README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/plugins/RenameFile/README.md b/plugins/RenameFile/README.md index a1f654f..6bf7a76 100644 --- a/plugins/RenameFile/README.md +++ b/plugins/RenameFile/README.md @@ -1,10 +1,7 @@ # RenameFile: Ver 0.5.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 +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]**. RenameFileViaTitleUnderEditTab RenameFileViaTitle_AfterSaved @@ -13,7 +10,20 @@ The [Title] field is located under the [Edit] tab. RenameFileViaTitle_AfterSaved_InExplorer -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. +The plugin can optionally append the following fields if they do not already exist in the file name. +- tags +- performers +- studio +- galleries +- resolution +- video_codec +- frame_rate +- date + +### 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, 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. From bd5b754389cbe463359a4db5ffd2d71732002bd0 Mon Sep 17 00:00:00 2001 From: David Maisonave <47364845+David-Maisonave@users.noreply.github.com> Date: Sun, 1 Sep 2024 13:20:54 -0400 Subject: [PATCH 2/4] Update README.md --- plugins/RenameFile/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/plugins/RenameFile/README.md b/plugins/RenameFile/README.md index 6bf7a76..7f34c41 100644 --- a/plugins/RenameFile/README.md +++ b/plugins/RenameFile/README.md @@ -21,9 +21,9 @@ The plugin can optionally append the following fields if they do not already exi - date ### 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, and do not edit the base (stem). +- 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. From 09f70681970ff863706204878819986ea006a3c2 Mon Sep 17 00:00:00 2001 From: David Maisonave <47364845+David-Maisonave@users.noreply.github.com> Date: Sun, 1 Sep 2024 13:24:05 -0400 Subject: [PATCH 3/4] Update README.md --- plugins/RenameFile/README.md | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/plugins/RenameFile/README.md b/plugins/RenameFile/README.md index 7f34c41..5125bdf 100644 --- a/plugins/RenameFile/README.md +++ b/plugins/RenameFile/README.md @@ -1,24 +1,24 @@ # RenameFile: Ver 0.5.0 (By David Maisonave) 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]**. RenameFileViaTitleUnderEditTab RenameFileViaTitle_AfterSaved -The [Title] field is located under the [Edit] tab. +- The [Title] field is located under the [Edit] tab. RenameFileViaTitle_AfterSaved_InExplorer -The plugin can optionally append the following fields if they do not already exist in the file name. -- tags -- performers -- studio -- galleries -- resolution -- video_codec -- frame_rate -- date +- The plugin can optionally append the following fields if they do not already exist in the file name. + - tags + - performers + - studio + - galleries + - resolution + - video_codec + - frame_rate + - date ### RenameFile vs RenameOnUpdate - 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) - 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: From d975ec1751b15681bb3c491c62ed39cccbfb7af5 Mon Sep 17 00:00:00 2001 From: David Maisonave <47364845+David-Maisonave@users.noreply.github.com> Date: Sun, 1 Sep 2024 13:31:18 -0400 Subject: [PATCH 4/4] Update README.md --- plugins/RenameFile/README.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/plugins/RenameFile/README.md b/plugins/RenameFile/README.md index 5125bdf..671bcfc 100644 --- a/plugins/RenameFile/README.md +++ b/plugins/RenameFile/README.md @@ -7,18 +7,11 @@ RenameFile is a [Stash](https://github.com/stashapp/stash) plugin. RenameFileViaTitle_AfterSaved - The [Title] field is located under the [Edit] tab. +- After clicking **[Save]**, the change can be seen in File Explorer momentarily. + - RenameFileViaTitle_AfterSaved_InExplorer -RenameFileViaTitle_AfterSaved_InExplorer - -- The plugin can optionally append the following fields if they do not already exist in the file name. - - tags - - performers - - studio - - galleries - - resolution - - video_codec - - frame_rate - - date +- 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 ### RenameFile vs RenameOnUpdate - Although RenameFile has a similar name to other plugins (RenameOnUpdate, Renamer, etc..), it's main purpose is entirely different.