diff --git a/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md b/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md index bae9402a976..3a178077479 100644 --- a/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md +++ b/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md @@ -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 @@ -792,83 +796,120 @@ 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 +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.