HTTP AniDB Metadata Agent (HAMA)

HAMA is a Plex Metadata Agent, initially created By Atomicstrawberry through v0.4 [2015-08-31].

Here are HAMA's features:

• Provides both Movies and Series agents
• AniDB ID to TVDB/TMDB ID matching (with studio and episode mapping list) via ScudLee's XML mappings
• Posters from TVDB (assign a poster to each AniDB ID in the AniDB to TVDB mapping file to avoid poster duplicates)
• TVDB episode screenshots
• Episode summary (in English only) courtesy of TVDB via ScudLee's XML episode mappings
• Prefers studio from mapping file, then AniDB (as is often missing from AniDB)
• Search part entirely local through AniDB HTML API database file anime-titles.xml
• Separate language order selection for the series name and episode titles in Agent Settings (Supports Kanji characters in folders, filenames, titles)
• Warnings in HTML report files (no poster available, episode summary empty, TVDB ID not in mapping file) to allow the community to update more easily the mapping XML or TVDB, or add missing episodes
• Collection mapping from ScudLee's movie collection ammended with AniDB RelatedAnime field
• Unique posters by using the AniDB rank in the mapping to rotate the posters
• when a series is not found in AniDB, search TVDB and TMDB automatically
• Trakt scrobbling supports HAMA GUIDs

Absolute Series Scanner (ASS):

It is strongly reccomended to use Absolute Series Scanner in combination with HAMA. If all video files are showing in Plex with the right season and episode number, the scanner did its job. For more info and install instructions please view the ASS readme here: https://github.com/ZeroQI/Absolute-Series-Scanner/blob/master/README.md

Local Media Assets

The built-in 'Local Media Assets' Plex agent is responsible for loading the following local files if present:

• Subtitles
• Movie trailer
• Theme song
• Background
• Series poster
• Series Season poster

More info:

https://support.plex.tv/hc/en-us/articles/200220677-Local-Media-Assets-Movies

https://support.plex.tv/hc/en-us/articles/200220717-Local-Media-Assets-TV-Shows

It is not enabled for HAMA by default; to change this find the tickboxes located at Settings > Server > Agents (Legacy) > Shows > HamaTV | HamaMovies > "Local Media Assets (TV)" and Settings > Server > Agents (Legacy) > Movies > HamaMovies > Local Media Assets (Movies)

Put this agent before HAMA to prioritize local files. Here is a table summarizing naming conventions:<BR />

<TABLE> <THEAD> <TR> <TH> Data type </TH> <TH> Source </TH> <TH> Comment </TH> </TR> </THEAD> <TBODY> <TR> <TD> fanart </TD> <TD> art/backdrop/background/fanart-1.ext </TD> <TD> -1 can be ommited </TD> </TR> <TR> <TD> Series poster </TD> <TD> Series folder: Show name-1/folder/poster/show.ext</TD> <TD> (jpg, jpeg, png, tbn) </TD> </TR> <TR> <TD> Season poster </TD> <TD> Season folder: Season01a.ext </TD> <TD> (jpg, jpeg, png, tbn) </TD> </TR> <TR> <TD> Banner </TD> <TD> banner/banner-1.jpg </TD> <TD> (jpg, jpeg, png, tbn) </TD> </TR> <TR> <TD> Theme song </TD> <TD> theme.mp3 </TD> <TD> (mp3) </TD> </TR> <TR> <TD> Subtitles </TD> <TD> file name.ext </TD> <TD> (srt, smi, ssa, ass) </TD> </TR> <TR> <TD> Trailers </TD> <TD> MovieName-Trailer.ext or in "Trailers" folder </TD> <TD> </TD> </TR> <TR> <TD> Plexignore files </TD> <TD> .plexignore </TD> <TD> </TD> </TR> </TBODY> </TABLE>

Local subtitle files are supported through the Local Media Assets agent.

Trailers can also be included this way. With "Local Media Assets (Movies)" enabled in the HamaMovies agent list, any files you name as MovieName-Trailer.ext or place in a 'Trailers' folder inside the movie's folder are picked up by Plex as trailers.

[!NOTE] I've done this for a few things where I have the trailer as a file, but I agree - it'd be even better if we can get Hama to add any S0E2xx as a 'trailer' extra too. Plex's trailer feature also supports displaying trailers from a URL - the metadata agent just needs to add the relevant URL where Plex can fetch the trailer. If we added support for this, it'd mean that user who don't have the trailer as a file can also benefit from having the trailer available.

Metadata sources

HAMA uses the AniDB HTTP title database and ScudLee's XML files with his approval. A new ScudLee fork is used for HAMA:

ScudLee's XMLs: https://github.com/Anime-Lists/anime-lists

ScudLee's XBMC AniDB mod agent: http://forum.xbmc.org/showthread.php?tid=142835&pid=1432010#pid1432010

Metadata is collected in the following files:

| File | Contents | | --- | --- | | anime-titles.xml | AniDB HTTP API, contains all anime titles, downloaded from http://anidb.net/api/anime-titles.xml.gz [API reference: http://wiki.anidb.net/w/API] | | anime-list-full.xml | Maps the AniDB ID to the TVDB ID, providing studio and episode mapping, TMDB/TVDB ID | | anime-list-master.xml | ScudLee's AniDB to TVDB xml mapping file, gives studio and episode mapping list for the episode overview, downloaded from here | | anime-movieset-list.xml | ScudLee's movie collection (Because XBMC only supports movie collection and the files were developed for AniDB mod XBMC plugin), downloaded from here. Allows movies to be grouped together |

HAMA downloads the XMLs from the internet (using Plex cache for 1 week), then local, then resource folder. For pictures and theme songs, it takes from the cache first, then the internet. The XMLs are downloaded (cached) and a copy is saved in the agent data folder in case of connection issues.

Log Files

HAMA creates HTML log files for any issues with links to facilitate updating the source databases used and even add missing episodes for everyone's benefit. Here are all the files that may be created in ...]/Plex Media Server/Plug-in Support/Data/com.plexapp.agents.hama/DataItems, with some examples of error reports they may contain:

• AniDB posters missing.htm
• AniDB summaries missing.htm
• anime-list anidbid missing.htm
• anime-list studio logos.htm <pre><code>anidbid: <a href='http://anidb.net/perl-bin/animedb.pl?show=anime&aid=266' target='_blank'>266</a> | Title: 'Case Closed' | AniDB and anime-list are both missing the studio</code></pre>
• anime-list tvdbid missing.htm
• TVDB posters missing.htm
• TVDB season posters missing.htm <pre><code>tvdbid: <a href='http://thetvdb.com/?tab=series&id=307112' target='_blank'>307112</a> | Title: 'Hybrid x Heart Magias Academy Ataraxia'</code></pre>
• TVDB summaries missing.htm <pre><code><a href='http://thetvdb.com/?tab=series&id=101621' target='_blank'>101621</a> missing summaries: ['s0e1', 's0e2', 's0e3', 's0e4', 's0e5', 's0e6', 's0e7', 's0e8', 's0e9', 's0e10', 's0e11', 's0e35', 's1932e0', 's1932e1', 's1932e3', 's1932e4', 's1932e5', 's1932e6', 's1932e7', 's1932e8', 's1932e9', 's1932e10', 's1932e11', 's1933e12', 's1933e13', 's1933e14', 's1933e15', 's1934e1', 's1934e2', 's1934e3', 's1934e6', 's1934e7', 's1934e8', 's1934e9', 's1934e10', 's1934e11', 's1934e12', 's1934e13', 's1935e1', 's1935e2', 's1935e3', 's1935e4', 's1935e5', 's1935e8', 's1935e10', 's1936e2', 's1936e4', 's1936e5', 's1936e6', 's1936e7', 's1936e8', 's1936e11', 's1937e1', 's1937e2', 's1937e9', 's1937e10', 's1937e11', 's1937e12', 's1938e1', 's1938e2', 's1938e3', 's1938e4', 's1938e5', 's1938e6', 's1938e7', 's1938e8', 's1938e9', 's1938e10', 's1938e12', 's1939e3', 's1939e4', 's1939e6']<br /></code></pre>
• Plex themes missing.htm <pre><code><a href='https://plexapp.zendesk.com/hc/en-us/articles/201572843' target='_blank'>Restrictions</a><br /> tvdbid: <a href='http://thetvdb.com/?tab=series&id=79796' target='_blank'>79796</a> | Title: 'Air Gear' | <a href='mailto:themes@plexapp.com?cc=&subject=Missing%20theme%20song%20-%20&#39;%20-%2079796.mp3&#39;' target='_blank'>Upload</a><br /></code></pre>
• Missing episodes.htm <pre><code>anidbid: <a href='http://anidb.net/perl-bin/animedb.pl?show=anime&aid=4196' target='_blank'>4196</a> | Title: 'Air Gear' | Missing Episodes: ['s1e1', 's1e2', 's1e3', 's1e4', 's1e5', 's1e6', 's1e7', 's1e8', 's1e9', 's1e10', 's1e11', 's1e12', 's1e13', 's1e14', 's1e15', 's1e16', 's1e17', 's1e18', 's1e19', 's1e20', 's1e21', 's1e22', 's1e23', 's1e24', 's1e25']</code></pre> <pre><code>tvdbid: <a href='http://thetvdb.com/?tab=series&id=78914' target='_blank'>78914</a> | Title: 'Full Metal Panic!' | Missing Episodes: ['s3e1', 's3e2', 's3e3', 's3e4', 's3e5', 's3e6', 's3e7', 's3e8', 's3e9', 's3e10', 's3e11', 's3e12', 's3e13']<br /></code></pre>
• Missing Episode Summaries.htm <pre><code>tvdbid: <a href='http://thetvdb.com/?tab=series&id=81797' target='_blank'>81797</a> | Title: 'One Piece' | Missing Episode Summaries: ['753']<br /></code></pre>
• Missing Special Summaries.htm <pre><code>tvdbid: <a href='http://thetvdb.com/?tab=series&id=83322' target='_blank'>83322</a> | Title: 'A Certain Magical Index' | Missing Special Summaries: ['s0e1', 's0e2', 's0e3', 's0e4']<br /></code></pre>
• Missing Specials.htm <pre><code>anidbid: <a href='http://anidb.net/perl-bin/animedb.pl?show=anime&aid=8166' target='_blank'>8166</a> | Title: 'A Bridge to the Starry Skies' | Missing Episodes: ['s0e2', 's0e1', 's0e3', 's0e5', 's0e4', 's0e8', 's0e7', 's0e6', 's0e9']<br /></code></pre>

The metadata ID from An