![]() |
Summary | Adds additional icons for external links. |
![]() |
Repository (primary) | CommunityScripts |
![]() |
Source URL (primary) | https://stashapp.github.io/CommunityScripts/stable/index.yml |
![]() |
Repository (secondary) | QxxxGit |
![]() |
Source URL (secondary) | https://qxxxgit.github.io/stash-plugins/index.yml |
![]() |
Install | How to install a plugin? |
NOTE: The primary repository will be more up-to-date, with community contributions of custom icons (e.g. sites supported by StashDB). The secondary repository is a bare bones install without community contributions.
This plugin is for the community to change and update as much it likes. If you’re using the CommunityScripts installation, please report bugs to the CommunityScripts repository.
Supported Links
The following sites are supported out of the box:
- Facebook (facebook.com)
- Instagram (instagram.com)
- Patreon (patreon.com)
- Reddit (reddit.com)
- Telegram (telegram.com | t.me)
- TikTok (tiktok.com)
- Tumblr (tumblr.com)
- Twitch (twitch.tv)
- Twitter (twitter.com | x.com)
- VK (vk.com)
- YouTube (youtube.com)
Installation
It is recommended to use the CommunityScripts repository for installing the plugin. However, if you do not want the custom icons contributed by the community, go to Settings > Plugins in Stash, and click the green Add Source button to add the secondary Source URL. Then simply install the plugin.
Creating a custom icon
First, you’ll need to locate the custom/
directory found in the plugin’s directory. This houses custom.json
along with the custom icons.
NOTE: Images and SVGs are supported when using an icon.
In custom.json
, you will find link definitions. Below is an example definition.
{
name: "sitename",
icon: "myicon.png",
addresses: ["mysitename.com"]
}
The name
is a unique identifier. The icon
can be an SVG or image. The addresses
array will be used in conjunction with the regex
property (not shown above since it’s not required) for link detection to properly categorize the icons. The default/fallback regex is https?:\/\/(?:www\.)?${addr}\/
After you’ve created your definitions, simply toss your icons in the same directory as custom.json
.
Things to know
The plugin will fetch both the custom.json
and icon files from the hard-coded plugin directory:
./plugin/externalLinksEnhanced/assets/custom
This means if you rename the externalLinksEnhanced
directory, things will break. You would need to update customAssetPath
in the externalLinksEnhanced.js
file.