CommunityScripts repository

This repository contains plugins, themes, userscripts and other utility scripts created by the Stash community.

More extensive list of plugins and other projects for Stash is available on our documentation site.

Plugins

Note

More plugins are available at https://docs.stashapp.cc/plugins.

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 manually

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.

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

Note

More themes are available at 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.
2. In Stash, go to Settings > Interface and scroll down to Custom CSS heading.
3. Make sure Custom CSS enabled is checked.
4. Click on Edit under Custom CSS and then paste the CSS code into the text box.
5. 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.

Browser extension

To install the userscript you will need a browser extension such as:

• Violentmonkey
• Tampermonkey
• Greasemonkey

Installing

1. Go to usersripts directory.
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.
   

Scripts

Note

More scripts are available at https://docs.stashapp.cc/scripts.

To install/run a script follow the install instructions listed in individual README files.

Contributing

Formatting

Formatting is enforced on all files. Follow this setup guide:

1. Yarn and its dependencies must be installed to run the formatting tools.

   yarn install --frozen-lockfile

2. Python dependencies must also be installed to format py files.

   pip install -r requirements.txt

Formatting non-py files

yarn run format

Formatting py files

py files are formatted using black.

yarn run format-py

Deprecation

To be formalized.