|
1 | 1 | ## Obsidian Media DB Plugin |
2 | 2 |
|
3 | | -This plugin can query multiple APIs for movies, series, anime, etc. and creates notes containing their information. |
| 3 | +This plugin can query multiple APIs for movies, series, anime and games, and creates notes containing their information. |
| 4 | + |
| 5 | +### Features |
| 6 | +#### Search by Title |
| 7 | +Search by the Name of the movie, series, anime or game. |
| 8 | + |
| 9 | +#### Search by ID |
| 10 | +Allows you to search by an ID that varies from API to API. Concrete info can be found in the description of the individual APIs. |
| 11 | + |
| 12 | +### Currently supported APIs: |
| 13 | +- [Jikan](https://jikan.moe/), an API that uses [My Anime List](https://myanimelist.net) |
| 14 | + - supported formats |
| 15 | + - series |
| 16 | + - movies |
| 17 | + - specials |
| 18 | + - OVAs |
| 19 | + - authentication |
| 20 | + - no authentication needed |
| 21 | + - SFW filter support |
| 22 | + - yes |
| 23 | + - Search by ID |
| 24 | + - the ID you need is the ID of the anime on [My Anime List](https://myanimelist.net) |
| 25 | + - you can find this ID in the URL |
| 26 | + - e.g. for "Beyond the Boundary" the URL looks like this `https://myanimelist.net/anime/18153/Kyoukai_no_Kanata` so the ID is `18153` |
| 27 | + - notes |
| 28 | + - the api is very slow sometimes, this is normal |
| 29 | + - the titles have to be with the titles that they have on [My Anime List](https://myanimelist.net), which are in most cases the japanese titles |
| 30 | + - e.g. instead of "Demon Slayer" you have to search "Kimetsu no Yaiba" |
| 31 | + - the API is rate limited to |
| 32 | + - 60 requests per minute |
| 33 | + - 3 requests per second |
| 34 | +- [OMDb](https://www.omdbapi.com/) |
| 35 | + - supported formats |
| 36 | + - series |
| 37 | + - movies |
| 38 | + - games |
| 39 | + - authentication |
| 40 | + - an API key is needed |
| 41 | + - you can get one for free [here](https://www.omdbapi.com/apikey.aspx) |
| 42 | + - SFW filter support |
| 43 | + - no, but I haven't encountered ant NSFW content in testing |
| 44 | + - Search by ID |
| 45 | + - the ID you need is the ID of the movie or show on [IMDb](https://www.imdb.com) |
| 46 | + - you can find this ID in the URL |
| 47 | + - e.g. for "Rogue One" the URL looks like this `https://www.imdb.com/title/tt3748528/` so the ID is `tt3748528` |
| 48 | + - notes |
| 49 | + - the api is rate limited to 1000 requests a day |
| 50 | + |
| 51 | +### Currently supported media types |
| 52 | +- movies (including specials) |
| 53 | +- series (including OVAs) |
| 54 | +- games |
| 55 | + |
| 56 | +### Contributions |
| 57 | +Thank you for wanting to contribute to this project. |
| 58 | + |
| 59 | +Contributions are always welcome. If you have an idea, feel free to open a feature request under the issue tab or even create a pull request. |
| 60 | + |
0 commit comments