Skip to content

docs: Update scraper objects #5794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 88 additions & 46 deletions ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

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

```yaml
Expand Down Expand Up @@ -792,83 +796,121 @@ driver:
```

## Object fields
### Performer

### 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
Gender
URL
Twitter
Instagram
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

```
Aliases
Birthdate
CareerLength
Circumcised
Country
DeathDate
DeathDate
Details
Disambiguation
Ethnicity
Country
HairColor
EyeColor
FakeTits
Gender
HairColor
Height
Weight
Measurements
FakeTits
CareerLength
Tattoos
Name
PenisLength
Piercings
Aliases
Tags (see Tag fields)
Image
Details
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

```
Title
Details
Code
Director
URL
Date
Details
Director
Groups (see Group Fields)
Image
Performers (see Performer fields)
Studio (see Studio Fields)
Groups (see Group Fields)
Tags (see Tag fields)
Performers (list of Performer fields)
Title
URLs
```

> **Important**: `Title` field is required only if fileless.

### Studio

```
Name
URL
```

> **Important**: `Name` field is required.

### Tag
```
Name
```

### Group
```
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)
```
> **Important**: `Name` field is required.