afiqzudinhadi/obsidian-media-db-sync
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions
No description
45 commits 2 branches 1 tag 1.8 MiB
Find a file
mProjectsCode 5916ed66eb Steam API
2022-05-29 20:01:33 +02:00
.github/workflows Update release.yml 2022-05-12 23:27:39 +02:00
src Steam API 2022-05-29 20:01:33 +02:00
.editorconfig Initial commit 2022-05-04 14:43:20 +02:00
.eslintignore Initial commit 2022-05-04 14:43:20 +02:00
.eslintrc Initial commit 2022-05-04 14:43:20 +02:00
.gitignore Initial commit 2022-05-04 14:43:20 +02:00
.npmrc Initial commit 2022-05-04 14:43:20 +02:00
esbuild.config.mjs scaffolding 2022-05-04 17:45:42 +02:00
LICENSE.md Rename LICENSE to LICENSE.md 2022-05-11 23:46:51 +02:00
manifest.json bump version number 2022-05-19 10:38:44 +02:00
package-lock.json scaffolding 2022-05-04 17:45:42 +02:00
package.json scaffolding 2022-05-04 17:45:42 +02:00
README.md Steam API 2022-05-29 20:01:33 +02:00
styles.css search by id 2022-05-11 23:41:55 +02:00
tsconfig.json Initial commit 2022-05-04 14:43:20 +02:00
version-bump.mjs Initial commit 2022-05-04 14:43:20 +02:00
versions.json bump version 2022-05-17 22:57:43 +02:00

README.md

Obsidian Media DB Plugin

A plugin that can query multiple APIs for movies, series, anime, games, music and wiki articles, and import them into your vault.

Features

Search by Title

Search a movie, series, anime, game, music release or wiki article by its name across multiple APIs.

Search by ID

Allows you to search by an ID that varies from API to API. Concrete information on this feature can be found in the description of the individual APIs.

Templates

The plugin allows you to set a template note that gets added to the end of any note created by this plugin.
The plugin also offers simple "template tgs". E.g. if the template includes {{ title }}, it will be replaced by the title of the movie, show or game.
Note that "template tags" are surrounded with two curly braces and that the spaces inside the curly braces are important.

For arrays there are two special ways of displaying them.

  • using {{ LIST:variable_name }} will result in 
      - element 1    
  - element 2    
  - element 3    
  - ...
  • using {{ ENUM:variable_name }} will result in 
      element 1, element 2, element 3, ...

Available variables that can be used in template tags are the same variables from the metadata of the note.

I also published my own templates here.

How to install

Currently, you have to manually download the zip archive from the latest release here on GitHub.
After downloading, extract the archive into the .obsidian/plugins folder in your vault.

The folder structure should look like this:

[path to your vault]  
|_ .obsidian  
   |_ plugins  
      |_ obsidian-media-db-plugin  
         |_ main.js  
         |_ manifest.json  
         |_ styles.css

Once the plugin submission goes through, the plugin will also be installable directly through obsidian's plugin installer.

How to use

(pictures are coming)

Once you have installed this plugin, you will find a database icon in the left ribbon.
When using this or the Add new Media DB entry command, a popup will open.
Here you can enter the title of what you want to search for and then select in which APIs to search.

After clicking search, a new popup will open prompting you to select from the search results.
Now you select the result you want and the plugin will cast it's magic and create a new note in your vault, that contains the metadata of the selected search result.

Currently supported media types

  • movies (including specials)
  • series (including OVAs)
  • games
  • music releases
  • wiki articles

Currently supported APIs:

Name Description Supported formats Authentification Rate limiting SFW filter support
Jikan Jikan is an API that uses My Anime List and offers metadata for anime. series, movies, specials, OVAs No 60 per minute and 3 per second Yes
OMDb OMDb is an API that offers metadata for movie, series and games. series, movies, games Yes, you can get a free key here here 1000 per day No
MusicBrainz MusicBrainz is an API that offers information about music releases. music releases No 50 per second No
Wikipedia The Wikipedia API allows access to all Wikipedia articles. wiki articles No None No
Steam The Steam API offers information on all steam games. games No 10000 per day No

Notes

  • Jikan
    • sometimes the api is very slow, this is normal
    • you need to use the title the anime has on My Anime List, which is in most cases the japanese title
      • e.g. instead of "Demon Slayer" you have to search "Kimetsu no Yaiba"

Search by ID

  • Jikan
    • the ID you need is the ID of the anime on My Anime List
    • you can find this ID in the URL
      • e.g. for "Beyond the Boundary" the URL looks like this https://myanimelist.net/anime/18153/Kyoukai_no_Kanata so the ID is 18153
  • OMDb
    • the ID you need is the ID of the movie or show on IMDb
    • you can find this ID in the URL
      • e.g. for "Rogue One" the URL looks like this https://www.imdb.com/title/tt3748528/ so the ID is tt3748528
  • MusicBrainz
    • the id of a release is not easily accessible, you are better off just searching by title
  • Wikipedia
    • here is a guide to finding the Wikipedia ID for an article
  • Steam
    • you can find this ID in the URL
      • e.g. for "Factorio" the URL looks like this https://store.steampowered.com/app/427520/Factorio/ so the ID is 427520

Problems, unexpected behavior or improvement suggestions?

You are more than welcome to open an issue on GitHub.

Contributions

Thank you for wanting to contribute to this project.

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.

Credits

Credits go to: