Skip to content

Commit bbd9ae7

Browse files
committed
Revise README.md to improve community support section and update plugin hosting instructions
1 parent d0d0b2a commit bbd9ae7

File tree

1 file changed

+13
-64
lines changed

1 file changed

+13
-64
lines changed

README.md

Lines changed: 13 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -2,83 +2,32 @@
22

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

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
66

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

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
1012

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

23-
Installed plugins can be updated or uninstalled from the **Installed Plugins** section.
15+
Repository: https://github.com/stashapp/plugins-repo-template
2416

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
3418

3519
> [!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).
3721
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
5623

5724
> [!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).
6726
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-
![image](https://github.com/user-attachments/assets/62dd4258-a4fc-4610-8103-9a3fc7e396a9)
75-
76-
## Scripts
27+
## Other projects
7728

7829
> [!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).
8231
8332
## Contributing
8433

0 commit comments

Comments
 (0)