Skip to content

Commit 84827d2

Browse files
authored
Update README
1 parent 5f0c0ab commit 84827d2

File tree

1 file changed

+66
-38
lines changed

1 file changed

+66
-38
lines changed

README.md

Lines changed: 66 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,80 @@
1-
# CommunityScripts Repository
1+
# CommunityScripts repository
22

3-
This repository contains plugin and utility scripts created by the Stash community and hosted on the official GitHub repo.
3+
This repository contains plugins, themes, userscripts and other utility scripts created by the Stash community.
44

5-
There is also [a list of third-party plugins in our documentation](https://docs.stashapp.cc/add-ons/third-party-integrations).
5+
More extensive list of plugins and other projects for Stash is available [on our documentation site](https://docs.stashapp.cc/plugins).
66

7-
## Please note: V24 now uses an installer
8-
# We recommend you use that to install (and update) plugins.
9-
Manual installs are not recommended, and you shouldn't do so unless you otherwise know what you are doing.
7+
## Plugins
108

11-
## How To Install
12-
To download a plugin in Stash v24, the CommunityScripts repo source is automatically installed by default.
9+
> [!NOTE]
10+
> More plugins are available at [https://docs.stashapp.cc/plugins](https://docs.stashapp.cc/plugins).
1311
14-
This default source is located at https://stashapp.github.io/CommunityScripts/stable/index.yml
12+
### Installing via manager
1513

16-
# Plugin, Themes, and Scripts Directory
17-
We used to list all community supported plugins, themes, and scripts in this repository...
18-
but with the changes in v24, ANY items installable by the plugin installer will no longer listed here.
19-
Use the Plugin Installer built into Stash.
14+
Plugins can be installed and managed from the **Settings** > **Plugins** page.
2015

21-
We will continue to list the items NOT otherwise installable in this way below.
16+
Plugins are installed using the **Available Plugins** section. The **Community (stable)** source is configured by default.
17+
Source is located at `https://stashapp.github.io/CommunityScripts/stable/index.yml`.
2218

23-
## NOTE: BREAKING CHANGES
24-
The recent v24 release (and future development branches) had major breaking changes to old schema and plugin changes.
25-
We're beginning to review plugins and the rest and patch them to work, but it's an ongoing process...
19+
Installed plugins can be updated or uninstalled from the **Installed Plugins** section.
2620

27-
We'll update the table below as we do this...
28-
We will also be rearranging things a bit, and updating documentation (including this page)
21+
### Installing manually
2922

30-
## Plugins will no longer be listed individually here...
23+
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.
3124

32-
Category|Triggers|Plugin Name|Description|Minimum Stash version|Updated for v24|
33-
--------|-----------|-----------|-----------|---------------------|-----
34-
Maintenance|Task<br />Scene.Update|[renamerOnUpdate](plugins/renamerOnUpdate)|Rename/Move your file based on Stash metadata.|v2.4|:white_check_mark: STOPGAP
35-
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:
36-
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:
37-
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:
38-
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:
39-
Scanning|Scene.Create|[pathParser](plugins/pathParser)|Updates scene info based on the file path.|v0.17|:x:
40-
Scanning|Scene.Create|[titleFromFilename](plugins/titleFromFilename)|Sets the scene title to its filename|v0.17|:x:
41-
Reporting||[TagGraph](plugins/tagGraph)|Creates a visual of the Tag relations.|v0.7|:x:
25+
Plugins are added by adding configuration yaml files (format: `pluginName.yml`) to the plugins directory.
26+
27+
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.
4228

4329
## Themes
4430

45-
# A Variety of Themes are now available to be one click installed via the Plugin Setting page in your Stash
46-
We welcome new themes, as well as patches to existing themes.
31+
> [!NOTE]
32+
> More themes are available at [https://docs.stashapp.cc/themes](https://docs.stashapp.cc/themes).
33+
34+
### Installing via manager
35+
36+
Plugins can be installed and managed from the **Settings** > **Plugins** page.
37+
38+
Plugins are installed using the **Available Plugins** section. The **Community (stable)** source is configured by default.
39+
Source is located at `https://stashapp.github.io/CommunityScripts/stable/index.yml`.
40+
41+
Installed plugins can be updated or uninstalled from the **Installed Plugins** section.
42+
43+
### Installing via Custom CSS
44+
45+
1. Find a theme from the list and copy the content of .css file.
46+
1. In Stash, go to **Settings** > **Interface** and scroll down to **Custom CSS** heading.
47+
1. Make sure **Custom CSS enabled** is checked.
48+
1. Click on **Edit** under **Custom CSS** and then paste the CSS code into the text box.
49+
1. You will need to force-reload **Shift+F5** in order to see the theme.
50+
51+
## Userscripts
52+
53+
> [!NOTE]
54+
> More userscripts are available at [https://docs.stashapp.cc/userscripts](https://docs.stashapp.cc/userscripts).
4755
48-
## Utility Scripts
56+
### Browser extension
4957

50-
|Category|Name|Description|Updated for v24|
51-
---------|---------------|-----------|----
52-
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:
53-
Kodi|[Kodi Helper](scripts/kodi-helper)|Generates `nfo` and `strm` for use with Kodi.|v0.7|:x:
58+
To install the userscript you will need a browser extension such as:
59+
60+
- [Violentmonkey](https://violentmonkey.github.io)
61+
- [Tampermonkey](https://www.tampermonkey.net)
62+
- [Greasemonkey](https://www.greasespot.net)
63+
64+
### Installing
65+
66+
1. Go to [usersripts directory](https://github.com/stashapp/CommunityScripts/tree/main/userscripts).
67+
2. Find the usersccript you want to install.
68+
3. Select the `.user.js` file.
69+
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.
70+
![image](https://github.com/user-attachments/assets/62dd4258-a4fc-4610-8103-9a3fc7e396a9)
71+
72+
## Scripts
73+
74+
> [!NOTE]
75+
> More scripts are available at [https://docs.stashapp.cc/scripts](https://docs.stashapp.cc/scripts).
76+
77+
To install/run a script follow the install instructions listed in individual README files.
5478

5579
## Contributing
5680

@@ -80,4 +104,8 @@ yarn run format
80104

81105
```sh
82106
yarn run format-py
83-
```
107+
```
108+
109+
## Deprecation
110+
111+
To be formalized.

0 commit comments

Comments
 (0)