You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-23Lines changed: 26 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,15 @@
1
1
## Obsidian Media DB Plugin
2
2
3
-
A plugin that can query multiple APIs for movies, series, anime, manga, books, comics, games, music and wiki articles, and import them into your vault.
3
+
A plugin that can query multiple APIs for movies, series, anime, manga, books, comics, games, music, and wiki articles, and import them into your vault.
4
+
5
+
> [!WARNING]
6
+
> This README refers to the in-development version of the plugin. The README for the latest release can be found [here](https://github.com/mProjectsCode/obsidian-media-db-plugin/blob/release/README.md).
4
7
5
8
### Features
6
9
7
10
#### Search by Title
8
11
9
-
Search a movie, series, anime, manga, book, comic, game, music release or wiki articles by its name across multiple APIs.
12
+
Search for movies, series, anime, manga, books, comics, games, music releases, or wiki articles by their name across multiple APIs.
10
13
11
14
#### Search by ID
12
15
@@ -15,10 +18,10 @@ Allows you to search by an ID that varies from API to API. Concrete information
15
18
#### Templates
16
19
17
20
The plugin allows you to set a template note that gets added to the end of any note created by this plugin.
18
-
The plugin also offers simple template tags, for example `{{ title }}`, which will be replaced by the title of the media you are importing.
19
-
Note that template tags are surrounded with two curly braces and spaces. The spaces inside the curly braces are important!
21
+
The plugin also offers simple template tags, for example `{{ title }}`, which will be replaced by the title of the media being imported.
22
+
Note that template tags are surrounded by two curly braces and spaces. The spaces inside the curly braces are important!
20
23
21
-
For arrays there are two special ways of displaying them:
24
+
For arrays, there are two special ways of displaying them:
22
25
23
26
- using `{{ LIST:variable_name }}` will result in:
24
27
```
@@ -38,11 +41,11 @@ I also published my own templates [here](https://github.com/mProjectsCode/obsidi
38
41
39
42
#### Download poster images
40
43
41
-
The plugin offers a setting to automatically download the poster images for a new media, ensuring offline access. The images are saved as `type_title (year)` e.g. `movie_The Perfect Storm (2000)` in a userchosen folder.
44
+
The plugin offers a setting to automatically download the poster images for a new media, ensuring offline access. The images are saved as `type_title (year)` e.g. `movie_The Perfect Storm (2000)`, in a user-chosen folder.
42
45
43
46
#### Metadata field customization
44
47
45
-
Allows you to rename the metadata fields this plugin generates through mappings. The mappings can be set in the plugins settings.
48
+
Allows you to rename the metadata fields this plugin generates through mappings. The mappings can be set in the plugin's settings.
46
49
The three options for mapping are:
47
50
48
51
- `default`: Keep the original name
@@ -51,18 +54,18 @@ The three options for mapping are:
51
54
52
55
#### Bulk Import
53
56
54
-
The plugin allows you to import your preexisting media collection and upgrade them to Media DB entries.
57
+
The plugin allows you to import your preexisting media collection and upgrade it to Media DB entries.
55
58
56
59
##### Prerequisites
57
60
58
61
The preexisting media notes must be inside a folder in your vault.
59
-
For the plugin to be able to query them they need one metadata field that is used as the title the piece of media is searched by.
60
-
This can be achieved by for example using a `csv` import plugin to import an existing list from outside of obsidian.
62
+
For the plugin to be able to query them, they need one metadata field that is used as the title the piece of media is searched by.
63
+
This can be achieved by, for example, using a `csv` import plugin to import an existing list from outside of Obsidian.
61
64
62
65
##### Importing
63
66
64
67
To start the import process, right-click on the folder and select the `Import folder as Media DB entries` option.
65
-
Then specify the API to search, if the current note content and metadata should be appended to the Media DB entry and the name of the metadata field that contains the title of the piece of media.
68
+
Then specify the API to search, if the current note content and metadata should be appended to the Media DB entry, and the name of the metadata field that contains the title of the piece of media.
66
69
67
70
Then the plugin will go through every file in the folder and prompt you to select from the search results.
68
71
@@ -72,7 +75,7 @@ After all files have been imported or the import was canceled, you will find the
72
75
73
76
### How to install
74
77
75
-
**The plugin is now released, so it can be installed directly through obsidian's plugin installer.**
78
+
**The plugin is now released, so it can be installed directly through Obsidian's plugin installer.**
76
79
77
80
Alternatively, you can manually download the zip archive from the latest release here on GitHub.
78
81
After downloading, extract the archive into the `.obsidian/plugins` folder in your vault.
@@ -92,11 +95,11 @@ The folder structure should look like this:
92
95
### How to use
93
96
94
97
Once you have installed this plugin, you will find a database icon in the left ribbon.
95
-
When using this or the `Add new Media DB entry` command, a popup will open.
96
-
Here you can enter the title of what you want to search for and then select in which APIs to search.
98
+
When using this or the `Add new Media DB entry` command, a pop-up will open.
99
+
Here, you can enter the title of what you want to search for and then select which APIs to search.
97
100
98
-
After clicking search, a new popup will open prompting you to select from the search results.
99
-
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.
101
+
After clicking search, a new pop-up will open, prompting you to select from the search results.
102
+
Now you select the result you want, and the plugin will cast its magic, creating a new note in your vault that contains the metadata of the selected search result.
100
103
101
104
### Currently supported media types
102
105
@@ -114,20 +117,20 @@ Now you select the result you want and the plugin will cast it's magic and creat
114
117
| Name | Description | Supported formats | Authentification | Rate limiting | SFW filter support |
| [Jikan](https://jikan.moe/) | Jikan is an API that uses [My Anime List](https://myanimelist.net) and offers metadata for anime. | series, movies, specials, OVAs, manga, manwha, novels | No | 60 per minute and 3 per second | Yes |
117
-
| [OMDb](https://www.omdbapi.com/) | OMDb is an API that offers metadata for movie, series and games. | series, movies, games | Yes, you can get a free key here [here](https://www.omdbapi.com/apikey.aspx) | 1000 per day | No |
120
+
| [OMDb](https://www.omdbapi.com/) | OMDb is an API that offers metadata for movies, series, and games. | series, movies, games | Yes, you can get a free key here [here](https://www.omdbapi.com/apikey.aspx) | 1000 per day | No |
118
121
| [MusicBrainz](https://musicbrainz.org/) | MusicBrainz is an API that offers information about music releases. | music releases | No | 50 per second | No |
119
122
| [Wikipedia](https://en.wikipedia.org/wiki/Main_Page) | The Wikipedia API allows access to all Wikipedia articles. | wiki articles | No | None | No |
120
-
| [Steam](https://store.steampowered.com/) | The Steam API offers information on all steam games. | games | No | 10000 per day | No |
121
-
| [Open Library](https://openlibrary.org) | The OpenLibrary API offers metadata for books | books | No | Cover access is rate-limited when not using CoverID or OLID by max 100 requests/IP every 5 minutes. This plugin uses OLID so there shouldn't be a rate limit. | No |
123
+
| [Steam](https://store.steampowered.com/) | The Steam API offers information on all Steam games. | games | No | 10000 per day | No |
124
+
| [Open Library](https://openlibrary.org) | The OpenLibrary API offers metadata for books | books | No | Cover access is rate-limited when not using CoverID or OLID by max 100 requests/IP every 5 minutes. This plugin uses OLID, so there shouldn't be a rate limit. | No |
122
125
| [Moby Games](https://www.mobygames.com) | The Moby Games API offers metadata for games for all platforms | games | Yes, by making an account [here](https://www.mobygames.com/user/register/). NOTE: As of September 2024 the API key is no longer free so consider using Giant Bomb or steam instead | API requests are limited to 360 per hour (one every ten seconds). In addition, requests should be made no more frequently than one per second. | No |
123
126
| [Giant Bomb](https://www.giantbomb.com) | The Giant Bomb API offers metadata for games for all platforms | games | Yes, by making an account [here](https://www.giantbomb.com/login-signup/) | API requests are limited to 200 requests per resource, per hour. In addition, they implement velocity detection to prevent malicious use. If too many requests are made per second, you may receive temporary blocks to resources. | No |
124
127
| Comic Vine | The Comic Vine API offers metadata for comic books | comicbooks | Yes, by making an account [here](https://comicvine.gamespot.com/login-signup/) and going to the [api section](https://comicvine.gamespot.com/api/) of the site | 200 requests per resource, per hour. There is also a velocity detection to prevent malicious use. If too many requests are made per second, you may receive temporary blocks to resources. | No |
125
128
126
129
#### Notes
127
130
128
131
- [Jikan](https://jikan.moe/)
129
-
- sometimes the api is very slow, this is normal
130
-
- you need to use the title the anime has on [My Anime List](https://myanimelist.net), which is in most cases the japanese title
132
+
- sometimes the api is very slow; this is normal
133
+
- you need to use the title the anime has on [My Anime List](https://myanimelist.net), which is in most cases the Japanese title
131
134
- e.g. instead of "Demon Slayer" you have to search "Kimetsu no Yaiba"
132
135
133
136
#### Search by ID
@@ -145,7 +148,7 @@ Now you select the result you want and the plugin will cast it's magic and creat
145
148
- you can find this ID in the URL
146
149
- e.g. for "Rogue One" the URL looks like this `https://www.imdb.com/title/tt3748528/` so the ID is `tt3748528`
147
150
- [MusicBrainz](https://musicbrainz.org/)
148
-
- the id of a release is not easily accessible, you are better off just searching by title
151
+
- the id of a release is not easily accessible; you are better off just searching by title
149
152
- the search is generally for albums but you can have a more granular search like so:
150
153
- search for albums by a specific `artist:"Lady Gaga" AND primarytype:"album"`
151
154
- search for a specific album by a specific artist `artist:"Lady Gaga" AND primarytype:"album" AND releasegroup:"The Fame"`
@@ -172,7 +175,7 @@ Now you select the result you want and the plugin will cast it's magic and creat
172
175
- e.g. for "Boule & Bill" the URL looks like this `https://comicvine.gamespot.com/boule-bill/4050-70187/` so the ID is `4050-70187`
173
176
- Please note that only volumes can be added, not separate issues.
174
177
175
-
### Problems, unexpected behavior or improvement suggestions?
178
+
### Problems, unexpected behavior, or improvement suggestions?
176
179
177
180
You are more than welcome to open an issue on [GitHub](https://github.com/mProjectsCode/obsidian-media-db-plugin/issues).
0 commit comments