Backup_Repos/stash
1
0
Fork 0
mirror of https://github.com/stashapp/stash.git synced 2025-12-07 17:02:38 +01:00
Code Issues Projects Releases Wiki Activity

docs: Update scraper objects (#5794)

Browse source
This commit is contained in:
DogmaDragon 2025-06-02 10:16:42 +03:00 committed by GitHub
parent 10d4fcce8d
commit 5ea4c507b2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 95 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

149
ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md
View file

@ -2,6 +2,10 @@
Scrapers can be contributed to the community by creating a PR in [this repository](https://github.com/stashapp/CommunityScrapers/pulls). Scrapers can be contributed to the community by creating a PR in [this repository](https://github.com/stashapp/CommunityScrapers/pulls).
## XPath scraper templates
The most basic XPath scraper templates are available on [CommunityScrapers repository](https://github.com/stashapp/CommunityScrapers/tree/master/templates).
## Scraper configuration file format ## Scraper configuration file format
```yaml ```yaml
@ -799,83 +803,120 @@ driver:
``` ```
## Object fields ## Object fields
### Gallery
```
Code
Date
Details
Performers (see Performer fields)
Photographer
Rating
Studio (see Studio Fields)
Tags (see Tag fields)
Title
URLs
```
> **Important**: `Title` field is required.
### Group
```
Aliases
BackImage
Date
Director
Duration
FrontImage
Name
Rating
Studio (see Studio Fields)
Synopsis
Tags (see Tag fields)
URLs
```
> **Important**: `Name` field is required.
### Image
```
Code
Date
Details
Performers (see Performer fields)
Photographer
Rating
Studio (see Studio Fields)
Tags (see Tag fields)
Title
URLs
```
### Performer ### Performer
``` ```
Name
Gender
URL
Twitter
Instagram
Birthdate
DeathDate
Ethnicity
Country
HairColor
EyeColor
Height
Weight
Measurements
FakeTits
CareerLength
Tattoos
Piercings
Aliases Aliases
Tags (see Tag fields) Birthdate
Image CareerLength
Circumcised
Country
DeathDate
Details Details
Disambiguation
Ethnicity
EyeColor
FakeTits
Gender
HairColor
Height
Measurements
Name
PenisLength
Piercings
Tags (see Tag fields)
Tattoos
URLs
Weight
``` ```
*Note:* - `Gender` must be one of `male`, `female`, `transgender_male`, `transgender_female`, `intersex`, `non_binary` (case insensitive). > **Important**: `Name` field is required.
> **Note:** - `Gender` must be one of `male`, `female`, `transgender_male`, `transgender_female`, `intersex`, `non_binary` (case insensitive).
### Scene ### Scene
``` ```
Title
Details
Code Code
Director
URL
Date Date
Image Details
Studio (see Studio Fields) Director
Groups (see Group Fields) Groups (see Group Fields)
Image
Performers (see Performer fields)
Studio (see Studio Fields)
Tags (see Tag fields) Tags (see Tag fields)
Performers (list of Performer fields) Title
URLs
``` ```
> **Important**: `Title` field is required only if fileless.
### Studio ### Studio
``` ```
Name Name
URL URL
``` ```
> **Important**: `Name` field is required.
### Tag ### Tag
``` ```
Name Name
``` ```
### Group > **Important**: `Name` field is required.
```
Name
Aliases
Duration
Date
Rating
Director
Studio
Synopsis
URL
FrontImage
BackImage
```
### Gallery
```
Title
Details
URL
Date
Rating
Studio (see Studio Fields)
Tags (see Tag fields)
Performers (list of Performer fields)
```