|
2 | 2 |
|
3 | 3 | This repository contains plugins, themes, userscripts and other utility scripts created by the Stash community. |
4 | 4 |
|
5 | | -More extensive list of plugins and other projects for Stash is available [on our documentation site](https://docs.stashapp.cc/plugins). |
| 5 | +## Community support |
6 | 6 |
|
7 | | -## Join Our Community |
| 7 | +- **Forum:** [discourse.stashapp.cc](https://discourse.stashapp.cc) - Primary place for community support, feature requests, and discussions. |
| 8 | +- **Discord:** [discord.gg/2TsNFKt](https://discord.gg/2TsNFKt) - Real-time chat and community support. |
| 9 | +- **Lemmy:** [discuss.online/c/stashapp](https://discuss.online/c/stashapp) - Community discussions. |
8 | 10 |
|
9 | | -We are excited to announce that we have a new home for support, feature requests, and discussions related to Stash and its associated projects. Join our community on the [Discourse forum](https://discourse.stashapp.cc) to connect with other users, share your ideas, and get help from fellow enthusiasts. |
| 11 | +## Host your own plugins |
10 | 12 |
|
11 | | -## Plugins |
12 | | - |
13 | | -> [!NOTE] |
14 | | -> More plugins are available at [https://docs.stashapp.cc/plugins](https://docs.stashapp.cc/plugins). |
15 | | -
|
16 | | -### Installing via manager |
17 | | - |
18 | | -Plugins can be installed and managed from the **Settings** > **Plugins** page. |
19 | | - |
20 | | -Plugins are installed using the **Available Plugins** section. The **Community (stable)** source is configured by default. |
21 | | -Source is located at `https://stashapp.github.io/CommunityScripts/stable/index.yml`. |
| 13 | +We have a GitHub template available for those that prefer hosting on their own with step-by-step instructions to get started. |
22 | 14 |
|
23 | | -Installed plugins can be updated or uninstalled from the **Installed Plugins** section. |
| 15 | +Repository: https://github.com/stashapp/plugins-repo-template |
24 | 16 |
|
25 | | -### Installing manually |
26 | | - |
27 | | -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. |
28 | | - |
29 | | -Plugins are added by adding configuration yaml files (format: `pluginName.yml`) to the plugins directory. |
30 | | - |
31 | | -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. |
32 | | - |
33 | | -## Themes |
| 17 | +## Plugins |
34 | 18 |
|
35 | 19 | > [!NOTE] |
36 | | -> More themes are available at [https://docs.stashapp.cc/themes](https://docs.stashapp.cc/themes). |
| 20 | +> More plugins are available at [discourse.stashapp.cc](https://discourse.stashapp.cc/c/plugins/18). |
37 | 21 |
|
38 | | -### Installing via manager |
39 | | - |
40 | | -Plugins can be installed and managed from the **Settings** > **Plugins** page. |
41 | | - |
42 | | -Plugins are installed using the **Available Plugins** section. The **Community (stable)** source is configured by default. |
43 | | -Source is located at `https://stashapp.github.io/CommunityScripts/stable/index.yml`. |
44 | | - |
45 | | -Installed plugins can be updated or uninstalled from the **Installed Plugins** section. |
46 | | - |
47 | | -### Installing via Custom CSS |
48 | | - |
49 | | -1. Find a theme from the list and copy the content of .css file. |
50 | | -1. In Stash, go to **Settings** > **Interface** and scroll down to **Custom CSS** heading. |
51 | | -1. Make sure **Custom CSS enabled** is checked. |
52 | | -1. Click on **Edit** under **Custom CSS** and then paste the CSS code into the text box. |
53 | | -1. You will need to force-reload **Shift+F5** in order to see the theme. |
54 | | - |
55 | | -## Userscripts |
| 22 | +## Themes |
56 | 23 |
|
57 | 24 | > [!NOTE] |
58 | | -> More userscripts are available at [https://docs.stashapp.cc/userscripts](https://docs.stashapp.cc/userscripts). |
59 | | -
|
60 | | -### Browser extension |
61 | | - |
62 | | -To install the userscript you will need a browser extension such as: |
63 | | - |
64 | | -- [Violentmonkey](https://violentmonkey.github.io) |
65 | | -- [Tampermonkey](https://www.tampermonkey.net) |
66 | | -- [Greasemonkey](https://www.greasespot.net) |
| 25 | +> More themes are available at [discourse.stashapp.cc](https://discourse.stashapp.cc/tags/c/plugins/18/none/theme). |
67 | 26 |
|
68 | | -### Installing |
69 | | - |
70 | | -1. Go to [userscripts directory](https://github.com/stashapp/CommunityScripts/tree/main/userscripts). |
71 | | -2. Find the usersccript you want to install. |
72 | | -3. Select the `.user.js` file. |
73 | | -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. |
74 | | - |
75 | | - |
76 | | -## Scripts |
| 27 | +## Other projects |
77 | 28 |
|
78 | 29 | > [!NOTE] |
79 | | -> More scripts are available at [https://docs.stashapp.cc/scripts](https://docs.stashapp.cc/scripts). |
80 | | -
|
81 | | -To install/run a script follow the install instructions listed in individual README files. |
| 30 | +> More community projects are available at [discourse.stashapp.cc](https://discourse.stashapp.cc/c/plugins/other-projects/15). |
82 | 31 |
|
83 | 32 | ## Contributing |
84 | 33 |
|
|
0 commit comments