Skip to content

Commit 8c426a8

Browse files
authored
Update README.md
docs(readme): update README for v2.0.0 random button features
1 parent e10bf41 commit 8c426a8

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

plugins/StashRandomButton/README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
# Stash Random Button Plugin
22

3-
https://discourse.stashapp.cc/t/randombutton/1809
3+
[Plugin thread on Discourse](https://discourse.stashapp.cc/t/randombutton/1809)
44

5-
Adds a "Random" button to the image & scenes page to quickly navigate to a random scene.
5+
Adds a "Random" button to the Stash UI, letting you instantly jump to a random scene, image, performer, studio, group, tag, or gallery—including random "internal" navigation (e.g. a random scene inside a studio).
66

77
## Features
8-
- Adds a "Random" button to the Stash UI.
9-
- Selects a random scene via GraphQL query.
8+
9+
- Adds a "Random" button to the Stash UI navigation bar.
10+
- Supports random navigation for:
11+
- **Scenes** (global and within performer, studio, tag, group)
12+
- **Images** (global and within a gallery)
13+
- **Performers** (global)
14+
- **Studios** (global)
15+
- **Groups** (global)
16+
- **Tags** (global)
17+
- **Galleries** (global)
1018
- Lightweight, no external dependencies.
19+
- Uses Stash's GraphQL API.
20+
- Simple, robust, and easy to maintain.
1121

1222
## Installation
1323

@@ -30,11 +40,15 @@ Adds a "Random" button to the image & scenes page to quickly navigate to a rando
3040
- The button should appear on those pages.
3141

3242
## Usage
33-
Click the "Random" button in the navigation bar to jump to a random image or scene depending on the tab.
43+
Click the "Random" button in the navigation bar to jump to a random entity (scene, image, performer, studio, group, tag, or gallery) depending on your current page.
44+
- On internal entity pages (e.g., performer, studio, group, tag, gallery), the button picks a random scene or image from inside that entity.
3445

3546
## Requirements
3647
- Stash version v0.27.2 or higher.
3748

3849
## Development
3950
- Written in JavaScript using the Stash Plugin API.
4051
- Edit `random-button.js` to customize and reload plugins in Stash.
52+
53+
## Changelog
54+
- 2.0.0: Major upgrade! Now supports random navigation for performers, studios, groups, tags, galleries, and images (global and internal).

0 commit comments

Comments
 (0)