diff --git a/README.md b/README.md index 9b4a953..cd1d3db 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # IGDB Game Search for Obsidian -An [Obsidian](https://obsidian.md) plugin that lets you search for video games using the [IGDB](https://www.igdb.com/) (Internet Game Database) API and create notes with game metadata. +An [Obsidian](https://obsidian.md) plugin that lets you search for video games using the [IGDB](https://www.igdb.com/) (Internet Game Database) API and create templated notes with game metadata. ## Credits and Alternatives -This plugin is flat out copied from [obsidian-book-search-plugin](https://github.com/anpigon/obsidian-book-search-plugin) by [anpigon](https://github.com/anpigon). The only difference is that this one uses the IGDB API and populates game notes instead. +This plugin is almost entirely based on [obsidian-book-search-plugin](https://github.com/anpigon/obsidian-book-search-plugin) by [anpigon](https://github.com/anpigon). The only difference is that this one uses the IGDB API and populates game notes instead. If you're looking for alternatives, check out [obsidian-game-search-plugin](https://github.com/CMorooney/obsidian-game-search-plugin) by [CMorooney](https://github.com/CMorooney). @@ -18,6 +18,16 @@ If you're looking for alternatives, check out [obsidian-game-search-plugin](http - Customizable file naming and folder organization - Integration with [Templater](https://github.com/SilentVoid13/Templater) plugin +## Screenshots + +![Searching for a game](https://gist.github.com/user-attachments/assets/da6156b4-3f8b-4ce3-aa36-4320ed18d915) + +![Search Results](https://gist.github.com/user-attachments/assets/51cdbf83-f810-4189-8f5e-16323489efd5) + +![Automatic Note Creation](https://gist.github.com/user-attachments/assets/22c09984-3486-4dc2-86c7-b6acc50b6f1f) + +![Automatic Note Creation](https://gist.github.com/user-attachments/assets/a7587a86-d207-4dfc-8acc-02433639c3e8) + ## Requirements This plugin requires IGDB API credentials from Twitch. The IGDB API is free to use. @@ -38,8 +48,7 @@ This plugin requires IGDB API credentials from Twitch. The IGDB API is free to u ## Installation -I haven't configured any releases or set this up yet, though I'm willing to. At the -moment, I set this up for myself. +Search for this in the Obsidian Community Plugins or use [BRAT](https://github.com/TfTHacker/obsidian42-brat). ## Usage @@ -144,26 +153,51 @@ Rating: <%=game.rating ? game.rating + '/100' : 'N/A'%> ```markdown --- -title: "{{name}}" +tags: 🎮Game +id: {{id}} +name: "{{name}}" +releaseDate: {{releaseDate}} +releaseYear: {{releaseYear}} developer: "{{developer}}" +developers: [{{developers}}] publisher: "{{publisher}}" -releaseDate: {{releaseDate}} -genres: {{genres}} -platforms: {{platforms}} +publishers: [{{publishers}}] +developerLogo: {{developerLogo}} +genres: [{{genres}}] +gameModes: [{{gameModes}}] +platforms: [{{platforms}}] +cover: {{coverUrl}} +coverSmallUrl: {{coverSmallUrl}} +coverBigUrl: {{coverBigUrl}} +localCover: {{localCoverImage}} rating: {{rating}} -status: backlog +ratingCount: {{ratingCount}} +aggregatedRating: {{aggregatedRating}} +aggregatedRatingCount: {{aggregatedRatingCount}} +url: {{url}} +websiteUrl: {{websiteUrl}} +game-status: backlog +created: {{ DATE:YYYY-MM-DD HH:mm:ss }} +updated: {{ DATE:YYYY-MM-DD HH:mm:ss }} --- # {{name}} -![cover]({{coverBigUrl}}) - ## Summary -{{summary}} +> {{summary}} + +## Storyline + +> {{storyline}} + +## Notes + + +## What I Liked -## My Notes +## What I Didn't Like ``` diff --git a/manifest.json b/manifest.json index af3ab21..a7798f8 100644 --- a/manifest.json +++ b/manifest.json @@ -1,10 +1,10 @@ { - "id": "igdb-game-search-plugin", - "name": "IGDB Game Search", - "version": "0.1.2", - "minAppVersion": "0.15.0", - "description": "Search for video games using IGDB and create notes.", - "author": "David Mohundro", - "authorUrl": "https://mohundro.com", - "isDesktopOnly": false -} \ No newline at end of file + "id": "igdb-game-search", + "name": "IGDB Game Search", + "version": "0.1.2", + "minAppVersion": "0.15.0", + "description": "Automatically create templated notes for video games from an IGDB-based API search.", + "author": "David Mohundro", + "authorUrl": "https://mohundro.com", + "isDesktopOnly": false +}