From 5ea4c507b289f06f496ab7b5b4b56efe2de1b82b Mon Sep 17 00:00:00 2001 From: DogmaDragon <103123951+DogmaDragon@users.noreply.github.com> Date: Mon, 2 Jun 2025 10:16:42 +0300 Subject: [PATCH] docs: Update scraper objects (#5794) --- .../src/docs/en/Manual/ScraperDevelopment.md | 149 +++++++++++------- 1 file changed, 95 insertions(+), 54 deletions(-) diff --git a/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md b/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md index 0581c6f1b..0ee1c0880 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 @@ -799,83 +803,120 @@ driver: ``` ## 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 ``` -Name -Gender -URL -Twitter -Instagram -Birthdate -DeathDate -Ethnicity -Country -HairColor -EyeColor -Height -Weight -Measurements -FakeTits -CareerLength -Tattoos -Piercings Aliases -Tags (see Tag fields) -Image +Birthdate +CareerLength +Circumcised +Country +DeathDate 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 + ``` -Title -Details Code -Director -URL Date -Image -Studio (see Studio Fields) +Details +Director Groups (see Group Fields) +Image +Performers (see Performer fields) +Studio (see Studio 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.