Support This Project

All projects made with passion 💙

Your support helps us continue developing and maintaining these projects. Consider sponsoring to help keep them alive!

CheapShark Deals Obsidian Plugin

This plugin for Obsidian fetches game deals and cheapest prices from the CheapShark API and organizes them into your notes.

Features

• Automated Deal Fetching: Automatically refreshes game deals at a set interval.
• Organized by Store: Deals are categorized and saved into separate notes for each game store (e.g., Steam, GOG.com).
• Cheapest Games Overview: A dedicated note lists the cheapest available deal for each unique game.
• Customizable Folder: Choose where your deal notes are saved, including support for subfolders.

How to Use

1. Install the plugin:

   • Go to the releases page of this repository (once available).
   • Download main.js and manifest.json from the latest release.
   • In your Obsidian vault, navigate to .obsidian/plugins/.
   • Create a new folder named obsidian-cheapshark.
   • Copy the downloaded main.js and manifest.json files into this new folder.
   • Restart Obsidian and enable the "CheapShark Deals" plugin in the settings.

2. Configure the settings:

   • Open Obsidian settings and go to "CheapShark Deals".
   • Folder Name: Specify the folder where you want the deal notes to be saved (e.g., Game Deals or Deals/CheapShark).
   • Enable Auto Refresh: Toggle this to enable automatic fetching of deals.
   • Refresh Interval (hours): If auto-refresh is enabled, set how often (in hours, 1-24) the plugin should fetch new deals.

3. Fetch Deals:

   • The plugin will fetch deals automatically based on your settings.
   • You can also manually trigger a fetch by running the "Fetch CheapShark Deals" command from the command palette.

Data Source

This plugin utilizes the CheapShark API to retrieve game deal information. All data is sourced directly from CheapShark.

For Developers

This plugin is built with TypeScript.

• main.ts: The main plugin logic.
• manifest.json: Plugin metadata.
• package.json: Project dependencies and scripts.
• tsconfig.json: TypeScript compiler configuration.

Build

To build the plugin, you'll need Node.js and npm installed.

1. Clone the repository.
2. Run npm install to install dependencies.
3. Run npm run build to compile the TypeScript to JavaScript.

This will generate main.js in the project root.