diff --git a/README.md b/README.md index 80fd405c..d712111c 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,80 @@ -# 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
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
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
Gallery.Create
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
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). + +### Installing via manager + +Plugins can be installed and managed from the **Settings** > **Plugins** page. + +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 + +> [!NOTE] +> More userscripts are available at [https://docs.stashapp.cc/userscripts](https://docs.stashapp.cc/userscripts). -## Utility Scripts +### Browser extension -|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: +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) + +### Installing + +1. Go to [usersripts 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 @@ -80,4 +104,8 @@ yarn run format ```sh yarn run format-py -``` \ No newline at end of file +``` + +## Deprecation + +To be formalized.