Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 47 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

Expand All @@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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

```

Expand Down
18 changes: 9 additions & 9 deletions manifest.json
Original file line number Diff line number Diff line change
@@ -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
}
"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
}
Loading