Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@Elaws
Elaws committed Mar 6, 2022
0 parents commit c3c6a88
Show file tree
Hide file tree
Showing 3 changed files with 382 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
custom: https://www.buymeacoffee.com/elawsdev4
152 changes: 152 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
# Videogames Script for Obsidian's Quickadd plugin

## Demo
![igdbDemo](https://user-images.githubusercontent.com/52013479/150051838-f68e23c2-2a3a-43e3-a25c-d6d8f4ba6830.gif)

If this script helped you and you wish to contribute :)

<a href="https://www.buymeacoffee.com/elawsdev4" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>

## Description
This script allows you to easily insert a videogame note into your Obsidian vault using [Quickadd plugin](https://github.com/chhoumann/quickadd) by @chhoumann. **Now also works on Mobile (make sure you use latest QuickAdd) !**

We use IGDB api to get the videogame information.

This script needs a **client id** and **client secret** for IGDB API that you can get [here](https://api-docs.igdb.com/#about). Steps to obtain **client id** and **client secret** are detailed [below](#how-to-obtain-client-id-and-secret).

## Disclaimer

The script and this tutorial are based on [Macro_MovieAndSeriesScript.md](https://github.com/chhoumann/quickadd/blob/master/docs/Examples/Macro_MovieAndSeriesScript.md) by @chhoumann.

**Please never run a script that you don't understand. I cannot and will not be liable for any damage caused by the use of this script. Regularly make a backup of your Obsidian's vault !**

## How to obtain client ID and secret.

1. Sign-in to this website : https://dev.twitch.tv/login.
2. Click on "Applications" :

![1](https://user-images.githubusercontent.com/52013479/151679962-4f510da2-bdb4-49d0-82f9-baaacb7bb4f6.png)

3. Click on "Register your application" :

![2](https://user-images.githubusercontent.com/52013479/151679974-093dc027-3d17-4ba4-8225-44f6eb5a7262.png)

4. In "Name", choose a name you want. In "OAuth Redirect URLs", write `http://localhost`. In "category", choose "Application Integration". Finally, click on "Create" :

![3](https://user-images.githubusercontent.com/52013479/151680007-4a96a8df-d6a2-483f-bab6-0f5454d909af.png)

5. Click on manage :

![4](https://user-images.githubusercontent.com/52013479/151680012-2d453d2b-6e1a-4e1e-8feb-2c6067f9cdfd.png)

6. Here are your `client id` and `client secret` ! To generate `client secret`, click on `new secret` (and copy it, it will disappear !) :

![5](https://user-images.githubusercontent.com/52013479/151680023-a243939d-b208-4a25-a256-a4bc49092a95.png)

7. Keep your `client id` and `client secret`, they will be needed in the steps [below](#installation).

## Installation
![igdbInstall](https://user-images.githubusercontent.com/52013479/150051891-f9330609-8521-402a-97f1-3288bb4186f3.gif)

0. Make sure you use latest QuickAdd version (at least 0.5.1) !
1. Save the [script](https://github.com/Elaws/script_videogames_quickAdd/releases) to your vault somewhere. Make sure it is saved as a JavaScript file, meaning that it has the `.js` at the end.
2. Create a new template in your designated templates folder. Example template is provided below.
3. Open the Macro Manager by opening the QuickAdd plugin settings and clicking `Manage Macros`.
4. Create a new Macro - you decide what to name it.
5. Add the user script to the command list.
6. Add a new Template step to the macro. This will be what creates the note in your vault. Settings are as follows:
1. Set the template path to the template you created.
2. Enable File Name Format and use `{{VALUE:fileName}}` as the file name format. You can specify this however you like. The `fileName` value is the name of videogame without illegal file name characters.
3. The remaining settings are for you to specify depending on your needs.
7. Click on the cog icon to the right of the script step to configure the script settings. This should allow you to enter the API client id and client secret you got from IGDB. **Please make sure no accidental spaces are inserted before or after API `client id` or `client secret` !**
8. Go back out to your QuickAdd main menu and add a new Macro choice. Again, you decide the name. This is what activates the macro.
9. Attach the Macro to the Macro Choice you just created. Do so by clicking the cog ⚙ icon and selecting it.

You can now use the macro to create notes with videogame information in your vault !

### Example template

Please also find a definition of the variables used in this template below (see : [Template variables definitions](#template-variables-definitions)).

````markdown
# {{VALUE:name}}

Title:: {{VALUE:name}}
linking:: [[% Videogames]]
Tags:: #📥/🎮/{{VALUE:tag}}
Developer:: {{VALUE:developerName}}
DeveloperLogo:: {{VALUE:developerLogo}}
Genre:: {{VALUE:genresFormatted}}
Modes:: {{VALUE:gameModesFormatted}}
Thumbnail:: {{VALUE:thumbnail}}
Release:: {{VALUE:release}}
URL:: [IGDB]({{VALUE:url}})
Date:: {{DATE}}
Recommender:: {{VALUE:recommender}}
Comment:: {{VALUE:comment}}
Rating:: {{VALUE:rating}}
Played:: {{VALUE:played}}

---

# Storyline

> {{VALUE:storylineFormatted}}

````

## Dataview rendering

Here is the dataview query used in the demo (replace `PATH` by your videogames notes path) :

```dataview
TABLE WITHOUT ID
("[[" + file.name + "|" + Title + "]]") AS Title,
Date,
Genre,
Modes,
("![coverImg|100](" + Thumbnail + ")") AS Cover,
("![DeveloperLogo|100](" + DeveloperLogo + ")") AS Developer,
Release,
URL,
Recommender,
Comment,
Rating
from "PATH"
```

The banner at the top of the document is rendered using [Obsidian-banners](https://github.com/noatpad/obsidian-banners) plugin.

## Template variables definitions

Please find here a definition of the possible variables to be used in your template. Simply write `{{VALUE:name}}` in your template, and replace `name` by the desired video game data, including :

`fileName`: Title of the game without illegal characters. Possibly used in template configuration to name your file.

`name`: The title of the game.

`tag`: A colored square that is orange if game has been played, red if not.

`developerName`: Name of the developer.

`developerLogo`: Logo of the developer (if available).

`genresFormatted`: A list of genres for this game, formatted as "genre1", "genre2", etc...

`gameModesFormatted`: A list of game modes for this game, formatted as "gameMode1", "gameMode2", etc...

`thumbnail`: A poster of the videogame (if available)

`release`: The year the game was released (if available)

`url`: URL to the IGDB page of the game.

`recommender`: The person (or organization, etc...) that recommended the book to you.

`comment`: A small personal comment on the videogame.

`rating`: Your videogame rating, /10.

`played`: If you played the game, this equals 1, otherwise 0 (this helps to filter dataview query).
217 changes: 217 additions & 0 deletions script_videogames_quickAdd.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
const notice = (msg) => new Notice(msg, 5000);
const log = (msg) => console.log(msg);

const API_URL = "https://api.igdb.com/v4/games";
const AUTH_URL = "https://id.twitch.tv/oauth2/token";
const GRANT_TYPE = "client_credentials";

const API_CLIENT_ID_OPTION ="IGDB API Client ID"
const API_CLIENT_SECRET_OPTION ="IGDB API Client secret"

var userData = {igdbToken: ""};
var AUTH_TOKEN;

module.exports = {
entry: start,
settings: {
name: "Videogames Script",
author: "Elaws",
options: {
[API_CLIENT_ID_OPTION]: {
type: "text",
defaultValue: "",
placeholder: "IGDB API Client ID",
},
[API_CLIENT_SECRET_OPTION]:{
type: "text",
defaultValue: "",
placeholder: "IGDB API Client secret",
},
},
},
};

let QuickAdd;
let Settings;
let savePath;

async function start(params, settings) {
QuickAdd = params;
Settings = settings;

var relativePath = QuickAdd.app.vault.configDir;
savePath = QuickAdd.obsidian.normalizePath(`${relativePath}/igdbToken.json`);

// Retrieve saved token or create and save one (in Obsidian's system directory as igdbToken.json)
// Token is generated from client ID and client secret, and lasts 2 months.
// Token is refreshed when request fails because of invalid token (every two months)
await readAuthToken();

const query = await QuickAdd.quickAddApi.inputPrompt(
"Enter videogame title: "
);
if (!query) {
notice("No query entered.");
throw new Error("No query entered.");
}

const searchResults = await getByQuery(query);

const selectedGame = await QuickAdd.quickAddApi.suggester(
searchResults.map(formatTitleForSuggestion),
searchResults
);
if (!selectedGame) {
notice("No choice selected.");
throw new Error("No choice selected.");
}

if(selectedGame.involved_companies)
{
var developer = (selectedGame.involved_companies).find(element => element.developer);
}


const isPlayed = await QuickAdd.quickAddApi.yesNoPrompt("Played ?");
let myRating = "/10";
let myRecommender = " ";
let comment = " ";

// If game already played, add a rating to it.
if(isPlayed){
myRating = await QuickAdd.quickAddApi.inputPrompt("Rating", null, "/10");
}

myRecommender = await QuickAdd.quickAddApi.inputPrompt("Recommender", null, " ");
comment = await QuickAdd.quickAddApi.inputPrompt("Comment", null, " ");

QuickAdd.variables = {
...selectedGame,
fileName: replaceIllegalFileNameCharactersInString(selectedGame.name),
// Each genre comes in {ID, NAME} pair. Here, get rid of ID to keep NAME only.
// POST request to IGDB in apiGet(query) uses IGDB API's expander syntax (see : https://api-docs.igdb.com/#expander)
genresFormatted: `${selectedGame.genres ? formatList((selectedGame.genres).map(item => item.name)) : " "}`,
gameModesFormatted: `${selectedGame.game_modes ? formatList((selectedGame.game_modes).map(item => item.name)) : " "}`,
//Developer name and logo
developerName: `${developer ? developer.company.name : " "}`,
developerLogo: `${developer ? (developer.company.logo ? ("https:" + developer.company.logo.url).replace("thumb", "logo_med") : " ") : " "}`,
// For possible image size options, see : https://api-docs.igdb.com/#images
thumbnail: `${selectedGame.cover ? "https:" + (selectedGame.cover.url).replace("thumb", "cover_big") : " "}`,
// Release date is given as UNIX timestamp.
release: `${selectedGame.first_release_date ? (new Date((selectedGame.first_release_date*1000))).getFullYear() : " "}`,
// Squares of different color to tag Obsidian's note, depending if game has already been played or not.
tag: `${isPlayed ? "\u{0001F7E7}" : "\u{0001F7E5}"}`,
// A short description of the game.
storylineFormatted: `${selectedGame.storyline ? (selectedGame.storyline).replace(/\r?\n|\r/g, " ") : " "}`,
rating: myRating,
played: `${isPlayed ? "1" : "0"}`,
// Who recommended the game ?
recommender: myRecommender,
// A short personal comment on the game.
comment
};
}

function formatTitleForSuggestion(resultItem) {
return `${resultItem.name} (${
(new Date((resultItem.first_release_date)*1000)).getFullYear()
})`;
}

async function getByQuery(query) {

const searchResults = await apiGet(query);

if(searchResults.message)
{
await refreshAuthToken();
return await getByQuery(query);
}

if (searchResults.length == 0) {
notice("No results found.");
throw new Error("No results found.");
}

return searchResults;
}

function formatList(list) {
if (list.length === 0 || list[0] == "N/A") return " ";
if (list.length === 1) return `${list[0]}`;

return list.map((item) => `\"${item.trim()}\"`).join(", ");
}

function replaceIllegalFileNameCharactersInString(string) {
return string.replace(/[\\,#%&\{\}\/*<>$\":@.]*/g, "");
}

async function readAuthToken(){

if(await QuickAdd.app.vault.adapter.exists(savePath))
{
userData = JSON.parse(await QuickAdd.app.vault.adapter.read(savePath));
AUTH_TOKEN = userData.igdbToken;
}
else {
await refreshAuthToken();
}
}

async function refreshAuthToken(){

const authResults = await getAuthentified();

if(!authResults.access_token){
notice("Auth token refresh failed.");
throw new Error("Auth token refresh failed.");
} else {
AUTH_TOKEN = authResults.access_token;
userData.igdbToken = authResults.access_token;
await QuickAdd.app.vault.adapter.write(savePath, JSON.stringify(userData));
}
}

async function getAuthentified() {
let finalURL = new URL(AUTH_URL);

finalURL.searchParams.append("client_id", Settings[API_CLIENT_ID_OPTION]);
finalURL.searchParams.append("client_secret", Settings[API_CLIENT_SECRET_OPTION]);
finalURL.searchParams.append("grant_type", GRANT_TYPE);

const res = await request({
url: finalURL.href,
method: 'POST',
cache: 'no-cache',
headers: {
'Content-Type': 'application/json'
}
})
return JSON.parse(res);
}

async function apiGet(query) {

try {
const res = await request({
url: API_URL,
method: 'POST',
cache: 'no-cache',
headers: {
'Client-ID': Settings[API_CLIENT_ID_OPTION],
'Authorization': "Bearer " + AUTH_TOKEN
},
// The understand syntax of request to IGDB API, read the following :
// https://api-docs.igdb.com/#examples
// https://api-docs.igdb.com/#game
// https://api-docs.igdb.com/#expander
body: "fields name, first_release_date, involved_companies.developer, involved_companies.company.name, involved_companies.company.logo.url, url, cover.url, genres.name, game_modes.name, storyline; search \"" + query + "\"; limit 15;"
})

return JSON.parse(res);
} catch (error) {
await refreshAuthToken();
return await getByQuery(query);
}
}

0 comments on commit c3c6a88

Please sign in to comment.