stg-annon / communityscripts

This is a public repository containing plugin and utility scripts created by the Stash Community.

CommunityScripts Repository

This repository contains plugin and utility scripts created by the Stash community and hosted on the official GitHub repo.

There is also a list of third-party plugins in our documentation.

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.

How To Install

To download a plugin in Stash v24, the CommunityScripts repo source is automatically installed by default.

This default source is located at https://stashapp.github.io/CommunityScripts/stable/index.yml

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.

We will continue to list the items NOT otherwise installable in this way below.

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...

We'll update the table below as we do this... We will also be rearranging things a bit, and updating documentation (including this page)

Plugins will no longer be listed individually here...

Category	Triggers	Plugin Name	Description	Minimum Stash version	Updated for v24
Maintenance	Task Scene.Update	renamerOnUpdate	Rename/Move your file based on Stash metadata.	v2.4	✅ STOPGAP
Maintenance	Set Scene Cover	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	❌
Scenes	SceneMarker.Create SceneMarker.Update	markerTagToScene	Adds primary tag of Scene Marker to the Scene on marker create/update.	v0.8 (46bbede)	❌
Scanning	Scene.Create Gallery.Create Image.Create	defaultDataForPath	Adds configured Tags, Performers and/or Studio to all newly scanned Scenes, Images and Galleries..	v0.8	❌
Scanning	Scene.Create Gallery.Create	filenameParser	Tries to parse filenames, primarily in {studio}.{year}.{month}.{day}.{performer1firstname}.{performer1lastname}.{performer2}.{title} format, into the respective fields	v0.10	❌
Scanning	Scene.Create	pathParser	Updates scene info based on the file path.	v0.17	❌
Scanning	Scene.Create	titleFromFilename	Sets the scene title to its filename	v0.17	❌
Reporting		TagGraph	Creates a visual of the Tag relations.	v0.7	❌

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.

Utility Scripts

Category	Name	Description	Updated for v24
StashDB	StashDB Submission Helper	Adds handy functions for StashDB submissions like buttons to add aliases in bulk to a performer	❌
Kodi	Kodi Helper	Generates nfo and strm for use with Kodi.	v0.7

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