Importing Boxsets

Boxsets are collections of movies and/or series discs. Another way of thinking about boxsets is they are single releases which span multiple movies or series.

File format

Boxsets are defined in a boxset.json file.

• Slug - A unique identifier for the boxset used in the url. This should be the same slug used for the release of each of the individual items (movies or series) which are part of the boxset.
• Asin - The Amazon.com identifier (optional)
• Upc - The universal product code from the boxset packaging
• Year - The year the boxset was released.
• Locale - The locale the boxset was released in (ex: en-us)
• RegionCode - The region code of the discs in the boxset (optional)
• Title - The title of the boxset
• Isbn - The ISBN identifier for the boxset (optional)
• Type - The type of the boxset: Movie, Series, or Mixed (This field is currently unused).
• ImageUrl - The url image for the front cover of the boxset.
• Discs - A list of the discs in the set
  • Index - An integer to specify the order of the discs in the boxset. It is recommended you order the discs in as logical way as possible (according to how they are ordered in the phyisical set or according to release date)
  • Name - The name of the disc
  • Format - The format of the disc (UHD, Blu-Ray, DVD)
  • Slug - The unique identifier for the disc. This must match the Slug in the disc.json for the imported disc.
  • TitleSlug - The slug used to identify the imported title in the metadata.json for the title.

Example

To illustrate the boxset import process, I will use the Indiana Jones 4-Movie Collection. (Source Code Here) To add this boxset, you must first add each of the individual titles. As you import each of the titles, you must use the same release slug for each of them. This will also be the same slug you use for the boxset.

For example, the first movie in the set would have the following release.json:

{
  "Slug": "2021-indiana-jones-4-movie-collection-4k",
  "Asin": "B08Z2MDGWQ",
  "Upc": "032429355546",
  "Year": 2021,
  "Locale": "en-us",
  "RegionCode": "1",
  "Title": "2021 UHD"
}

For each of the discs that you import, you need to specify a Name and a Slug in the discXX.json file. These fields are not added by default so they will have to be added manually.

{
  "Index": 1,
  "Slug": "indiana-jones-and-the-raiders-of-the-Lost-ark",
  "Name": "Indiana Jones and the Raiders of the Lost Ark",
  "Format": "UHD"
  ...
}

There is some ambiguity with discs which span the whole boxset. For example, the Indiana Jones Collection has a 5th disc which contains bonus materials for all 4 movies. In this case, just consider the bonus disc as part of the release of the first movie/series in the boxset unless there is another title that should clearly 'own' the bonus disc.

After importing the 5 discs from the set, you can build the boxset.json file for the boxset in the /sets folder. The boxset folder should be named:

<title> (<releaseYear>)

like:

Indiana Jones 4-Movie Collection (2021)

This folder should contain a front.jpg with an image to be used for the boxset as well as the boxset.json file.

Boxset.json Example

The boxset metadata can be filled in as follows:

{
  "Slug": "2021-indiana-jones-4-movie-collection-4k",
  "Asin": "B08Z2MDGWQ",
  "Upc": "032429355546",
  "Year": 2021,
  "Locale": "en-us",
  "RegionCode": "1",
  "Title": "Indiana Jones 4-Movie Collection",
  "Type": "Movie"
}

Notice the Slug is the same slug used for the release of each title we imported as part of boxset.

Then add each disc of the boxset:

"Discs": [
    {
      "Index": 1,
      "Name": "Indiana Jones and the Raiders of the Lost Ark",
      "Format": "UHD",
      "Slug": "indiana-jones-and-the-raiders-of-the-Lost-ark",
      "TitleSlug": "indiana-jones-and-the-raiders-of-the-Lost-ark-1981"
    }
    ...
]

As noted above, the Slug should match the slug specified in the discXX.json file above.

Automation

There is currently no automation around creating/importing boxsets. This is something that will added to ImportBuddy in the future.