Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 3.86 KB

README.md

File metadata and controls

53 lines (38 loc) · 3.86 KB

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 on our wiki page.

How To Install

To download a plugin, either clone the git repo, or download the files directly.

It is recommended that plugins are placed in their own subdirectory of your plugins directory. The plugins directory should be created as a subdirectory in the directory containing your config.yml file. This will be in $HOME/.stash by default.

When downloading directly click on the file you want and then make sure to click the raw button:

Plugin and Script Directory

This list keeps track of scripts and plugins in this repository. Please ensure the list is kept in alphabetical order.

NOTE: BREAKING CHANGES

The upcoming v24 release (and the current development branch) have breaking changes to schema, and also 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, but we STRONGLY recommend you do not use the development branch unless you are prepared to help with the patching. We will also be rearranging things a bit, and updating documentation (including this page)

Plugins

Category Triggers Plugin Name Description Minimum Stash version Updated for v24
Scraper Task GHScraper_Checker Compare local file against github file from the community scraper repo. v0.8
Maintenance Task
Scene.Update
renamerOnUpdate Rename/Move your file based on Stash metadata. v0.7
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

Theme Name Description Updated for v24
Plex Theme inspired by the popular Plex Interface

Utility Scripts

Category Userscript 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

Utility Scripts

Category Plugin Name Description Minimum Stash version Updated for v24
Kodi Kodi Helper Generates nfo and strm for use with Kodi. v0.7