Minecraft Mod Note Template + auto population of info from URL

[mitchkm]

I've been working on a Minecraft modpack and have been organizing it in Obsidian. Created a template and JS script that can quickly stub in a note for a mod with it's basic information given it's Cursforge or Modrinth link.

Template

<%*
const url = await tp.system.prompt("Enter Mod Url");
let result = await tp.user.getMCModInfoFromURL(tp, url);
let title;
if (result.success) {
	title = result.modInfo.title;
	title = title.replace(/[*"\\/<>:|?]/g,"");
    await tp.file.rename(`${title}`);
} else { // fallback on basic title prompting if get from url fails
	title = await tp.user.checkForTitleOrPrompt(tp);
}
-%>
---
title:  <%* tR += title %>
created: <% tp.file.creation_date("YYYY-MM-DD HH:mm") %>
tags:
- minecraft/mod
owner: <%* tR += result.modInfo.owner %>
description: <%* tR += result.modInfo.description %>
type:
client: <%* tR += result.modInfo.client_side %>
server: <%* tR += result.modInfo.server_side %>
url: <%* tR += result.modInfo.url %>
included-in:
---
# <%* tR += title %>
<% tp.file.cursor() %>

Prompts for the link to the mod. Then, creates a note populated with Owner, Title, Description, Client/Server sided, & URL for the mod placed in the front matter.

tp.user.getMCModInfoFromURL(tp)

async function my_function (tp, url) {
    let result = {success: false, modInfo: {}};
    const modInfoDefaults = {
        url: "",
        owner: "",
        title: "",
        description: "",
        server_side: true,
        client_side: true,
    };
    let metaInfo;
    try {
        let parsedModName;
        if (url.includes("modrinth")) {
            parsedModName = url.replace("https://modrinth.com/mod/", "").trim();
            
        }
        else if (url.includes("curseforge")) {
            parsedModName = url.replace("https://www.curseforge.com/minecraft/mc-mods/", "").trim();
        }

        // Make sure parsedModName exists, then try Modrinth api first for information.
        if (parsedModName) {
            try {
                const response = await tp.obsidian.requestUrl(`https://api.modrinth.com/v2/project/${parsedModName}`);
                const response2 = await tp.obsidian.requestUrl(`https://api.modrinth.com/v2/project/${parsedModName}/members`);
                metaInfo = await response.json;
                let owners = response2.json.filter(m => m.role == "Owner");            
                result.modInfo = {
                    url: url,
                    owner: owners[0].user.username,
                    title: metaInfo.title.trim(),
                    description: metaInfo.description,
                    server_side: metaInfo.server_side == "required",
                    client_side: metaInfo.client_side == "required",
                };
                result.success = true && result.modInfo.title;
            } catch(err) { console.warn("Modrinth API " + err); }

            // If Modrinth api doesn't hit, try cursforge api.
            if (!result.success) {
                const response = await tp.obsidian.requestUrl({url: `https://api.curseforge.com/v1/mods/search?gameId=432&slug=${parsedModName}`, headers: {'x-api-key': 'CURSEFORGE_API_KEY'}});
                metaInfo = await response.json.data[0];
                result.modInfo = {
                    url: url,
                    owner: metaInfo.authors[0].name,
                    title: metaInfo.name.trim(),
                    description: metaInfo.summary,
                    server_side: true, // assume needed; meta data not present
                    client_side: true, // assume needed; meta data not present
                };
                result.success = true && result.modInfo.title;
            }
        }
    } catch(err) {
       result.success = false;
       console.warn(err);
    }

    // console.log(result);
    if (!result.success) { result.modInfo = modInfoDefaults; };
    return result;
}
module.exports = my_function;

Takes the mod URL and parses info from it, hitting the Modrinth or Curseforge API to do so.

P.S. You will need your own API key to hit Curseforge. Read how to do that here.