diff --git a/.github/ISSUE_TEMPLATE/add-mod.yml b/.github/ISSUE_TEMPLATE/add-mod.yml index 7984936031..c2b3c1dacb 100644 --- a/.github/ISSUE_TEMPLATE/add-mod.yml +++ b/.github/ISSUE_TEMPLATE/add-mod.yml @@ -33,14 +33,6 @@ body: placeholder: https://github.com/Raicuparta/ow-mod-template validations: required: true - - type: input - id: thumbnailUrl - attributes: - label: Thumbnail URL - description: "Full URL to a thumbnail image that will be used on the website and mod manager. Ideally in a 3:1 ratio (example: 900 by 300 pixels)" - placeholder: https://user-images.githubusercontent.com/22628069/154112130-b777f618-245f-44c9-9408-e11141fc5fde.png - validations: - required: false - type: dropdown id: tags validations: diff --git a/mods.json b/mods.json index f87a556b3b..fe50954532 100644 --- a/mods.json +++ b/mods.json @@ -3457,8 +3457,7 @@ "tags": [ "content" ], - "authorDisplay": "Vambok", - "thumbnailUrl": "https://github.com/user-attachments/assets/199e06ff-891e-48b3-86a7-3c3ad3c7a48d" + "authorDisplay": "Vambok" }, { "name": "Mouse Fix", diff --git a/mods.schema.json b/mods.schema.json index b8d3430f24..e22ac2cc98 100644 --- a/mods.schema.json +++ b/mods.schema.json @@ -40,10 +40,6 @@ "type": "boolean", "description": "True if this mod isn't useful by itself, and only serves as a dependency for other mods." }, - "thumbnailUrl": { - "type": "string", - "description": "Full URL to a thumbnail image that will be used on the website and mod manager. Ideally in a 3:1 ratio (example: 900 by 300 pixels)" - }, "authorDisplay": { "type": "string", "description": "Custom name to show in the author field for this mod. Useful if your mod is in an organization, or made by multiple people. Leave blank to use the repository owner name." @@ -87,7 +83,7 @@ "type": "array", "description": "List of previous GitHub repository names. Used for merging download count history. Do not use if current repo is fork of original repo.", "items": {"type": "string"} - } + }, } } } diff --git a/scripts/src/mod-info.d.ts b/scripts/src/mod-info.d.ts index cf7f5db1a6..276ec58ef4 100644 --- a/scripts/src/mod-info.d.ts +++ b/scripts/src/mod-info.d.ts @@ -7,7 +7,6 @@ export type ModInfo = { name: string; uniqueName: string; repo: string; - thumbnailUrl?: string; alpha?: boolean; required?: boolean; utility?: boolean; diff --git a/scripts/src/modify-mod-list/index.ts b/scripts/src/modify-mod-list/index.ts index c803dfd5b3..f068a16ef8 100644 --- a/scripts/src/modify-mod-list/index.ts +++ b/scripts/src/modify-mod-list/index.ts @@ -20,7 +20,6 @@ type IssueForm = { name?: string; uniqueName?: string; repoUrl?: string; - thumbnailUrl?: string; alpha?: string; dlc?: string; utility?: string; @@ -40,7 +39,6 @@ async function run() { dlc, authorDisplay, tags, - thumbnailUrl, }: IssueForm = JSON.parse(core.getInput(Input.form)); if (!name || !repoUrl || !uniqueName) { @@ -91,10 +89,6 @@ async function run() { newMod.tags.push("requires-dlc"); } - if (thumbnailUrl) { - newMod.thumbnailUrl = thumbnailUrl; - } - const existingMod = mods.find( (modFromList) => uniqueName === modFromList.uniqueName ); @@ -107,7 +101,6 @@ async function run() { existingMod.alpha = newMod.alpha; existingMod.authorDisplay = newMod.authorDisplay; existingMod.tags = newMod.tags; - existingMod.thumbnailUrl = newMod.thumbnailUrl; } const newModDb: ModList = { diff --git a/scripts/src/update-database/fetch-mods.ts b/scripts/src/update-database/fetch-mods.ts index 0820428aa8..c3421a8c3a 100644 --- a/scripts/src/update-database/fetch-mods.ts +++ b/scripts/src/update-database/fetch-mods.ts @@ -60,7 +60,6 @@ export async function fetchMods( readme && readme.downloadUrl ? await generateModThumbnail( slug, - modInfo.thumbnailUrl, readme.downloadUrl, outputDirectory ) diff --git a/scripts/src/update-database/generate-mod-thumbnail.ts b/scripts/src/update-database/generate-mod-thumbnail.ts index 9349fdcb31..880955e7b3 100644 --- a/scripts/src/update-database/generate-mod-thumbnail.ts +++ b/scripts/src/update-database/generate-mod-thumbnail.ts @@ -18,16 +18,23 @@ type ThumbnailInfo = { export async function generateModThumbnail( slug: string, - thumbnailUrl: string | undefined, readmeUrl: string, outputDirectory: string ): Promise { - const rawImageFilePath = - (await downloadImage(thumbnailUrl, slug)) ?? - (await downloadImage(await getFirstImageUrl(readmeUrl), slug)); + const readme = await getReadmeMarkdown(readmeUrl); + + if (!readme) { + return {}; + } + + const firstImageUrl = getFirstImageUrl(readme, getRawContentUrl(readmeUrl)); + + if (firstImageUrl == null) return {}; + + const rawImageFilePath = await downloadImage(firstImageUrl, slug); if (rawImageFilePath == null) { - console.log(`Failed to download any thumbnail for ${slug}`); + console.log(`Failed to download image ${firstImageUrl} for ${slug}`); return {}; } @@ -103,20 +110,10 @@ export function getRawContentUrl(readmeUrl: string) { return readmeUrl.replace(/\/(?!.*\/).+/, ""); } -function tryGetUrl(url: string): URL | null { - try { - return new URL(url); - } catch { - return null; - } -} - -export async function getFirstImageUrl( - readmeUrl: string -): Promise { - const markdown = await getReadmeMarkdown(readmeUrl); - const baseUrl = getRawContentUrl(readmeUrl); - +export function getFirstImageUrl( + markdown: string, + baseUrl: string +): string | null { if (!markdown) return null; const parsed = new Parser().parse(markdown); @@ -124,17 +121,18 @@ export async function getFirstImageUrl( let event; while ((event = walker.next())) { const node = event.node; - if (node.type !== "image" || !node.destination) continue; - - const imageUrl = tryGetUrl(node.destination); - if ( - !imageUrl?.pathname.endsWith(".svg") && - imageUrl?.host !== "img.shields.io" + node.type === "image" && + node.destination && + !node.destination.endsWith(".svg") && + !node.destination.startsWith("https://img.shields.io/") && + !node.destination.startsWith("http://img.shields.io/") ) { - const fullUrl = imageUrl + const imageUrl = node.destination; + + const fullUrl = imageUrl.startsWith("http") ? // GitHub allows embedding images that actually point to webpages on github.com, so we have to replace the URLs here - node.destination.replace( + imageUrl.replace( /^https?:\/\/github.com\/(.+)\/(.+)\/blob\/(.+)\//gm, `${GITHUB_RAW_CONTENT_URL}/$1/$2/$3/` ) @@ -148,34 +146,27 @@ export async function getFirstImageUrl( return null; } -async function downloadImage( - imageUrl: string | undefined | null, +export async function downloadImage( + imageUrl: string, fileName: string ): Promise { - if (!imageUrl) return null; + const response = await fetch(imageUrl); - try { - const response = await fetch(imageUrl); - - if (!response.ok) { - return null; - } - - const temporaryDirectory = "tmp/raw-thumbnails"; - - if (!fs.existsSync(temporaryDirectory)) { - await fsp.mkdir(temporaryDirectory, { recursive: true }); - } - - const relativeImagePath = `${temporaryDirectory}/${fileName}`; - const fullImagePath = getPath(relativeImagePath); - - const image = await response.arrayBuffer(); - await fsp.writeFile(fullImagePath, Buffer.from(image)); - - return fullImagePath; - } catch (error) { - console.error(`Failed to download image from url ${imageUrl}: ${error}`); + if (!response.ok) { return null; } + + const temporaryDirectory = "tmp/raw-thumbnails"; + + if (!fs.existsSync(temporaryDirectory)) { + await fsp.mkdir(temporaryDirectory, { recursive: true }); + } + + const relativeImagePath = `${temporaryDirectory}/${fileName}`; + const fullImagePath = getPath(relativeImagePath); + + const image = await response.arrayBuffer(); + await fsp.writeFile(fullImagePath, Buffer.from(image)); + + return fullImagePath; }