# Using Mediux

> Find, choose and download community artwork for your media library.

Mediux is a community library of artwork for shows, movies, collections and
games. Browsing and downloading are open to everyone, with no account needed.
Building an integration? See the [API docs](https://docs-preview.mediux.io/api.md).

## Find a title

Search for a show, movie, collection, game, person, network, company or
category, and check the year when several titles share a name. To browse for
ideas, open the Shows, Movies, Collections, Games or Users indexes; a creator's
profile is a good start when you already like their style.

A show page links to its seasons and episodes, a collection page to its movies,
and a game page to related games. A page link that holds only a numeric ID
keeps working if the title is renamed.

## Sets, Boxsets and Loadouts

A **Set** is one creator's artwork for one show, movie, collection or game. A
show Set can include the show's seasons and episodes; a collection Set can
include its movies. Empty positions are normal: a Set doesn't need every
artwork type, and single images can use a different language or edition from
the Set.

A **Boxset** groups a creator's show, movie and collection Sets; a **Loadout**
groups their game Sets. Standalone artwork sits outside any Set.

The images that identify a title come from providers such as TMDB and IGDB.
They are separate from community artwork, which has its own creator and
downloadable file.

### Artwork types

| Type       | Shape    | Use                |
| ---------- | -------- | ------------------ |
| Poster     | 2:3      | Vertical cover     |
| Backdrop   | 16:9     | Wide background    |
| Logo       | Flexible | Wordmark or emblem |
| Square Art | 1:1      | Square image       |
| Thumb      | 16:9     | Compact wide image |
| Titlecard  | 16:9     | Episode image      |

A show poster and a season poster share a shape but not a subject, so check
both the type and the title it belongs to. Games use their own types:

| Type         | Shape    | Minimum   | Maximum   | Maximum file size |
| ------------ | -------- | --------- | --------- | ----------------- |
| Cover        | 2:3      | 600×900   | 2400×3600 | 20 MiB            |
| Wide Cover   | 92:43    | 460×215   | 3680×1720 | 20 MiB            |
| Square Cover | 1:1      | 512×512   | 4096×4096 | 15 MiB            |
| Background   | 16:9     | 1920×1080 | 3840×2160 | 20 MiB            |
| Hero         | 96:31    | 1920×620  | 7680×2480 | 20 MiB            |
| Logo         | Flexible | —         | —         | 7.5 MiB           |
| Icon         | 1:1      | 256×256   | 1024×1024 | 5 MiB             |

## Download artwork

Use **Download** on an artwork to save the creator's original file with a
descriptive filename. The smaller images on cards are previews: saving one
gives you less detail than the creator uploaded.

For several files, choose **Download assets** on a Set, Boxset or Loadout page
and pick files one by one, by type or by group (such as a season). One file
saves directly; two or more come in a ZIP built in your browser, up to 250 files
at a time. Extract the ZIP before using the images. If some files fail, the rest
still save and you're told it was partial; run the download again for the
missing ones.

Game Icons can also download as **ICO**, a static file with several icon sizes.

### Share a page, not an image

A title or Set page tells the recipient who made the artwork and what else is
available. An image URL points at one version of one file: when a creator
replaces the artwork, the replacement gets a new URL and the old one may stop
working. Copy links whole; editing the size or extension in an image URL isn't
a reliable way to get another format.

## Apply artwork

Your library app or launcher decides how artwork is applied.

- **Kometa (Plex):** a show, movie or collection Set's
  **YAML export** applies the whole Set. See
  [Use Set YAML with Kometa](https://docs-preview.mediux.io/api/guides/kometa.md).
- **Steam:** right-click the game in your Library, open **Properties →
  Customization**, and choose a downloaded file for each field: Cover for the
  portrait cover, Wide Cover for the wide capsule, Hero for the top of the game
  page and Logo over the Hero. Valve's
  [library asset reference](https://partner.steamgames.com/doc/store/assets/libraryassets)
  has the details.

## Follow new artwork

[Activity](https://mediux.io/feed) lists Sets that were recently added or had
artwork changed, with a [Games tab](https://mediux.io/feed/games). Renaming a
Set doesn't bring it back into the feed. Follow a creator to hear about their
new Sets; see [Your account](https://docs-preview.mediux.io/guides/account.md#notifications).

## Likes and Lists

With an account you can **Like** a Set or an image. The count is public, who
liked it is not, and a Like does nothing else: it doesn't notify the creator or
save the artwork.

A **List** is a collection you curate:

- an **Asset List** holds individual images (about 1,000);
- a **Media List** holds shows, movies and collections, with one chosen image
  per position, or none yet, so it can mirror your library (up to 500 titles);
- a **Game List** does the same for games.

Lists are private until you make them **Public**. Anyone can read a Public List;
others can **Subscribe** to it or **Clone** their own copy. Public List changes
can take up to an hour to show; making a List private or deleting it is
immediate. Apps you connect can read and edit your Lists with your permission.
