Obsidian Stats logoObsidian Stats

RA Search

by DesynchVT
5
4
3
2
1
Score: 50/100
Install Code

Description

Reviews

No reviews yet.

Stats

2
stars
106
downloads
1
forks
10
days
4
days
4
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
2
total issues
0
open issues
2
closed issues
67
commits

Latest Version

1.1.0
4 days ago

Changelog

Added ability to download the box art of your games to your device, rather than fetching them from RA's servers every time you launch Obsidian.

Both the Add game and Auto import commands now prefer to download the box art images, rather than fetching them from RA every single time.

You must regenerate a new base with RA Search: Create base to display local images rather than fetch from RA's servers. It's a tad annoying, but you should be able to overcome it. The base view will still fetch images from RA's servers if you don't have the box art for a particular game downloaded. Meaning, aside from regenerating the base, you shouldn't have to do anything.

New command!

  • Add missing box art: Does as it says on the tin.
    • Retroactively adds a 'cover' property on your existing games.
    • Box art images are downloaded to <game_note_directory>/boxart (default: RetroAchievements/library/boxart

New setting!

  • Download box art into vault: Auto download box art images on add/import games. Default: enabled.
    • If you turn this off, you have to manually run the above mentioned command to download box art images.

Why was this done?

  1. It saves bandwidth for both you and RA. Each image takes up about 125KB, so my own library of almost 200 games take up 21MB worth of images. It should be fine. It's simply cheaper and more efficient to only download once.
  2. Offline view. You can now see the images in your base regardless of internet connection or the status of RA's servers.
  3. It satisfies the reasonable request from the RA team.
See all version on GitHub

README file from

Github

Obsidian RA Search plugin

This plugin is not officially supported or endorsed by the RetroAchievements team. It is independently developed by DesynchVT.

Description

Easily import your RetroAchievements library with various metadata to discover connections and themes between your games.

demo of an Obsidian base with imported RA-supported titles

Usage

The plugin ships with just 3 easy-to-use commands. Before you can use any of them, you must set up your own RetroAchievements username and web API key in the settings. You can find your API key under your RA user settings.

Auto import RA library

Requires an RA account

As the name suggests, it imports every single game listed on your RA account. Choose to also import subsets in the settings! Skips already imported games.

You can choose to cancel the import by running Cancel auto import. Games added during the import before cancellation will remain in your vault.

Add game

Requires an RA account

Add any game or subset to your notes, whether or not you've played it before!

Create base

Automatically create a base within Obsidian, automatically showing files in your configured RA notes library. You can customize it from here yourself, it's just to get you going. As a side note, the boxart images used in the base are hosted on RetroAchievements official media host: https://media.retroachievements.org.

Settings

image of the settings menu in Obsidian

RA username

self explanatory.

RA web API key

Necessary to communicate with the RetroAchievements servers. Found under your RA user settings.

Properties as links

Save game metadata as internal links in your vault to create connections between them.

Auto open added game

Automatically open newly added game notes in a new tab. Does NOT affect auto import.

Game note directory

The path RA games are imported to.

Console subfolders

Enabled: Games go into subfolders of the console name (~/PlayStation/Crash Bandicoot)

Disabled: Games go into the root game note directory. (~/Crash Bandicoot (PlayStation))

Include subsets in auto import

Whether auto import includes subsets or not.

Show RA logo in ribbon menu

Toggle RA logo in ribbon menu. Clicking it runs the Add game command.

Installation

Click the link to install the RA Search plugin: https://community.obsidian.md/plugins/ra-search.

Or, search in the Obsidian Community tab in the settings of the Obsidian app and install it from there.

Manual installation

Option A: Install from a release

  1. Go to the releases page and download the latest release's main.js, manifest.json, and styles.css.
  2. In your vault, open (or create) the folder <vault>/.obsidian/plugins/ra-search/. The folder names must match exactly.
  3. Copy the three downloaded files into that folder.
  4. In Obsidian, open Settings -> Community plugins and select Reload (or fully restart Obsidian).
  5. Find RA Search in the list and toggle it on. Obsidian requires Settings -> Community plugins -> Turn off safe mode before any manually installed plugin can be enabled. Only install plugins from authors you trust.

Option B: Build from source

Requires Node.js (https://nodejs.org/) 18+ and npm.

  1. git clone https://github.com/DesynchVT/obsidian-ra-search-plugin.git

  2. cd obsidian-ra-search-plugin

  3. npm install

  4. npm run build

  5. Copy main.js, manifest.json, and styles.css into <vault>/.obsidian/plugins/ra-search/ and enable the plugin as in steps 4–5 from Option A.

Sponsors