Merge branch 'main' into Addtional-Files-Deleter

Author: DogmaDragon

.editorconfig

@@ -9,4 +9,4 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.md]
-trim_trailing_whitespace = false
+trim_trailing_whitespace = false

.github/workflows/deploy.yml

@@ -36,7 +36,7 @@ jobs:
       - run: |
           cd dev
           ../main/build_site.sh ../_site/develop
-      - uses: actions/upload-pages-artifact@v2
+      - uses: actions/upload-pages-artifact@v3
 
   deploy:
     environment:
@@ -47,4 +47,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4

.github/workflows/on_pr_check_code_format.yml

@@ -0,0 +1,24 @@
+name: Validate Plugins
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'plugins/**'
+      - 'themes/**'
+  pull_request:
+    branches: [main]
+    paths:
+      - 'plugins/**'
+      - 'themes/**'
+
+jobs:
+  validate:
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+    - run: cd ./validator && yarn install --frozen-lockfile
+    - run: node ./validate.js --ci

.github/workflows/on_push_check_code_format.yml

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["redhat.vscode-yaml", "esbenp.prettier-vscode"]
+}

.github/workflows/validate.yml

@@ -0,0 +1,22 @@
+{
+  "yaml.validate": true,
+  "yaml.disableAdditionalProperties": true,
+  "yaml.completion": true,
+  "yaml.extension.recommendations": true,
+  "yaml.hover": true,
+  "yaml.format.singleQuote": false,
+  "yaml.format.printWidth": 120,
+  "yaml.format.proseWrap": "always",
+  "yaml.schemas": {
+    "schema/plugin.schema.json": ["/plugins/**", "/themes/**"]
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

.prettierignore

@@ -1,83 +1,89 @@
-# CommunityScripts Repository
+# CommunityScripts repository
 
-This repository contains plugin and utility scripts created by the Stash community and hosted on the official GitHub repo.  
+This repository contains plugins, themes, userscripts and other utility scripts created by the Stash community.
 
-There is also [a list of third-party plugins in our documentation](https://docs.stashapp.cc/add-ons/third-party-integrations).
+More extensive list of plugins and other projects for Stash is available [on our documentation site](https://docs.stashapp.cc/plugins).
 
-## Please note: V24 now uses an installer
-# We recommend you use that to install (and update) plugins.  
-Manual installs are not recommended, and you shouldn't do so unless you otherwise know what you are doing.
+## Plugins
 
-## How To Install
-To download a plugin in Stash v24, the CommunityScripts repo source is automatically installed by default.
+> [!NOTE]
+> More plugins are available at [https://docs.stashapp.cc/plugins](https://docs.stashapp.cc/plugins).
 
-This default source is located at https://stashapp.github.io/CommunityScripts/stable/index.yml
+### Installing via manager
 
-# Plugin, Themes, and Scripts Directory
-We used to list all community supported plugins, themes, and scripts in this repository...
-but with the changes in v24, ANY items installable by the plugin installer will no longer listed here.
-Use the Plugin Installer built into Stash.
+Plugins can be installed and managed from the **Settings** > **Plugins** page.
 
-We will continue to list the items NOT otherwise installable in this way below.
+Plugins are installed using the **Available Plugins** section. The **Community (stable)** source is configured by default.  
+Source is located at `https://stashapp.github.io/CommunityScripts/stable/index.yml`.
 
-## NOTE: BREAKING CHANGES
-The recent v24 release (and future development branches) had major breaking changes to old schema and plugin changes.
-We're beginning to review plugins and the rest and patch them to work, but it's an ongoing process...
+Installed plugins can be updated or uninstalled from the **Installed Plugins** section.
 
-We'll update the table below as we do this...
-We will also be rearranging things a bit, and updating documentation (including this page)
+### Installing manually
 
-## Plugins will no longer be listed individually here...
+By default, Stash looks for plugin configurations in the plugins sub-directory of the directory where the stash config.yml is read. This will either be the `%USERPROFILE%\.stash\plugins` on Windows or `/root/.stash/plugins` on Unix systems (Mac, Linux, etc.) or the current working directory.
 
-Category|Triggers|Plugin Name|Description|Minimum Stash version|Updated for v24|
---------|-----------|-----------|-----------|---------------------|-----
-Maintenance|Task<br />Scene.Update|[renamerOnUpdate](plugins/renamerOnUpdate)|Rename/Move your file based on Stash metadata.|v2.4|:white_check_mark: STOPGAP
-Maintenance|Set Scene Cover|[setSceneCoverFromFile](plugins/setSceneCoverFromFile)|Searchs Stash for Scenes with a cover image in the same folder and sets the cover image in stash to that image|v0.7|:x:
-Scenes|SceneMarker.Create<br />SceneMarker.Update|[markerTagToScene](plugins/markerTagToScene)|Adds primary tag of Scene Marker to the Scene on marker create/update.|v0.8 ([46bbede](https://github.com/stashapp/stash/commit/46bbede9a07144797d6f26cf414205b390ca88f9))|:x:
-Scanning|Scene.Create<br />Gallery.Create<br />Image.Create|[defaultDataForPath](plugins/defaultDataForPath)|Adds configured Tags, Performers and/or Studio to all newly scanned Scenes, Images and Galleries..|v0.8|:x:
-Scanning|Scene.Create<br />Gallery.Create|[filenameParser](plugins/filenameParser)|Tries to parse filenames, primarily in {studio}.{year}.{month}.{day}.{performer1firstname}.{performer1lastname}.{performer2}.{title} format, into the respective fields|v0.10|:x:
-Scanning|Scene.Create|[pathParser](plugins/pathParser)|Updates scene info based on the file path.|v0.17|:x:
-Scanning|Scene.Create|[titleFromFilename](plugins/titleFromFilename)|Sets the scene title to its filename|v0.17|:x:
-Reporting||[TagGraph](plugins/tagGraph)|Creates a visual of the Tag relations.|v0.7|:x:
+Plugins are added by adding configuration yaml files (format: `pluginName.yml`) to the plugins directory.
+
+Loaded plugins can be viewed in the **Settings** > **Plugins** page. After plugins are added, removed or edited while Stash is running, they can be reloaded by clicking **Reload plugins** button.
 
 ## Themes
 
-# A Variety of Themes are now available to be one click installed via the Plugin Setting page in your Stash
-We welcome new themes, as well as patches to existing themes.
+> [!NOTE]
+> More themes are available at [https://docs.stashapp.cc/themes](https://docs.stashapp.cc/themes).
 
-## Utility Scripts
+### Installing via manager
 
-|Category|Name|Description|Updated for v24|
----------|---------------|-----------|----
-StashDB  |[StashDB Submission Helper](/userscripts/StashDB_Submission_Helper)|Adds handy functions for StashDB submissions like buttons to add aliases in bulk to a performer|:x:
-Kodi|[Kodi Helper](scripts/kodi-helper)|Generates `nfo` and `strm` for use with Kodi.|v0.7|:x:
+Plugins can be installed and managed from the **Settings** > **Plugins** page.
 
-## Contributing
+Plugins are installed using the **Available Plugins** section. The **Community (stable)** source is configured by default.  
+Source is located at `https://stashapp.github.io/CommunityScripts/stable/index.yml`.
+
+Installed plugins can be updated or uninstalled from the **Installed Plugins** section.
+
+### Installing via Custom CSS
+
+1. Find a theme from the list and copy the content of .css file.
+1. In Stash, go to **Settings** > **Interface** and scroll down to **Custom CSS** heading.
+1. Make sure **Custom CSS enabled** is checked.
+1. Click on **Edit** under **Custom CSS** and then paste the CSS code into the text box.
+1. You will need to force-reload **Shift+F5** in order to see the theme.
+
+## Userscripts
 
-### Formatting
+> [!NOTE]
+> More userscripts are available at [https://docs.stashapp.cc/userscripts](https://docs.stashapp.cc/userscripts).
 
-Formatting is enforced on all files. Follow this setup guide:
+### Browser extension
 
-1. **[Yarn](https://yarnpkg.com/en/docs/install)** and **its dependencies** must be installed to run the formatting tools.
-    ```sh
-    yarn install --frozen-lockfile
-    ```
+To install the userscript you will need a browser extension such as:
+ 
+- [Violentmonkey](https://violentmonkey.github.io)
+- [Tampermonkey](https://www.tampermonkey.net)
+- [Greasemonkey](https://www.greasespot.net)
 
-2. **Python dependencies** must also be installed to format `py` files.
-    ```sh
-    pip install -r requirements.txt
-    ```
+### Installing
+
+1. Go to [userscripts directory](https://github.com/stashapp/CommunityScripts/tree/main/userscripts).
+2. Find the usersccript you want to install.
+3. Select the `.user.js` file.
+4. Click `Raw` button. It should either autoamtically prompt your browser extension or you will need to manually copy all the content and create new userscript in the extension yourself.  
+![image](https://github.com/user-attachments/assets/62dd4258-a4fc-4610-8103-9a3fc7e396a9)
+
+## Scripts
+
+> [!NOTE]
+> More scripts are available at [https://docs.stashapp.cc/scripts](https://docs.stashapp.cc/scripts).
+
+To install/run a script follow the install instructions listed in individual README files.
+
+## Contributing
 
-#### Formatting non-`py` files
+Submit a PR to add your plugin, theme, userscript and other utility script to the repository. 
 
-```sh
-yarn run format
-```
+## Deprecation
 
-#### Formatting `py` files
+14-day notice and associated issue with the appropriate label will be created once plugins, themes, userscripts and other utility scripts are marked for deprecation to allow time for someone to take over the development.
 
-`py` files are formatted using [`black`](https://pypi.org/project/black/).
+After the 14 days, if nobody takes up the development they will be moved to the [archive](./archive) directory. This will automatically remove plugins from the CommunityScripts source index.
 
-```sh
-yarn run format-py
-```
+Maintainers are expected to show commitment and demonstrate meaningful effort to maintain the code.