diff --git a/docs/mods.md b/docs/mods.md index 0d26978dc..470c8aad8 100644 --- a/docs/mods.md +++ b/docs/mods.md @@ -515,6 +515,10 @@ published. Players find them at [playhorizon.dev/mods](https://playhorizon.dev/m 5. A reviewer merges it: within minutes the file is a release of horizon-mods, and the project is on the site and in the launcher. +Once it is published, its page and its card in the launcher show its downloads (GitHub's counts of its files, +refreshed every hour) and its rating: players signed in with GitHub on its page give it 1 to 5 stars, one rating per +account, which they can change. Its owners can't rate it, and nobody sees who rated. + An update is the same form with a new version; only the project's `owners` can publish one, signed with its key if it has one. A published file never changes. Without the form, open the pull request by hand (the repository's README says how). The formats: [api/mod-index.md](api/mod-index.md). diff --git a/website/build.mjs b/website/build.mjs index b979f83f8..8e93c82b4 100644 --- a/website/build.mjs +++ b/website/build.mjs @@ -18,7 +18,7 @@ import { CPUS, GPUS, singleThread } from "./src/hardware.js"; import { isGame, isLauncher, launcherVersion, newestFirst } from "./src/versions.js"; import { contributorsFrom, contributorsHtml } from "./src/contributors.js"; import { areaFilterHtml, boardFilterHtml, boardFrom, boardHtml, creditFrom, creditHtml, helpWantedHtml, journalFrom, journalHtml, journalJson, overviewHtml, roadmapHtml, slimIssue, suggestItemsHtml } from "./src/hub.js"; -import { INDEX_URL, KINDS, SUBMIT, listHtml, projectHtml, readIndex, submitHtml } from "./src/mods.js"; +import { INDEX_URL, KINDS, SORTS, SUBMIT, listHtml, projectHtml, readIndex, sorted, submitHtml } from "./src/mods.js"; const site = dirname(fileURLToPath(import.meta.url)); const dist = join(site, "dist"); @@ -484,10 +484,11 @@ const modsList = `

ModsMade for Horizon, r ${KINDS.map(([k, label]) => ` `).join("\n")} +

${modProjects.length} of ${modProjects.length}

-${listHtml(modProjects)} +${listHtml(sorted(modProjects, "downloads"))}
`; const modPages = [ { file: "mods.html", path: "/mods", title: "Mods", description: "Mods, modpacks and resource packs made for Horizon, reviewed, each with what it may do and how to install it.", main: modsList }, diff --git a/website/src/mods-page.js b/website/src/mods-page.js index 121ba8067..335e863bd 100644 --- a/website/src/mods-page.js +++ b/website/src/mods-page.js @@ -1,32 +1,47 @@ -// /mods and /mods/: the registry's list (kind filter, search) and a project's page. The pages are baked from -// the index at build time; this fetches the published index again so a project merged since shows at once. -import { INDEX_URL, KINDS, listHtml, matches, projectHtml, readIndex } from "./mods.js"; +// /mods and /mods/: the registry's list (kind filter, search, order) and a project's page. The pages are baked +// from the index at build time; this fetches the published index again so a project merged since shows at once, +// the ratings (crates/horizon-mod-registry), and on a project's page the signed-in player's own rating to change. +import { API, INDEX_URL, KINDS, RATINGS, SORTS, listHtml, matches, projectHtml, rateHtml, ratingOf, readIndex, sorted, starsHtml } from "./mods.js"; import { cached, setUpMenu, setUpTheme } from "./chrome.js"; +import { escape } from "./markdown.js"; const root = document.getElementById("mods"); const baked = readIndex(JSON.parse(document.getElementById("mods-index").textContent || "null")) || []; let projects = baked; +// Every project's ratings, once the service answered. +let ratings = null; let kind = "all"; let text = ""; +let order = "downloads"; +// On a project's page: the signed-in account ({login, csrf}) or null, and its own rating of the project. +let me; +let mine = null; const id = (location.pathname.match(/^\/mods\/([a-z0-9_]+)\/?$/) || [])[1]; function showList() { const list = root.querySelector("#mod-list"); if (!list) return; - const shown = projects.filter((p) => matches(p, kind, text)); - list.innerHTML = listHtml(shown); + const shown = sorted(projects.filter((p) => matches(p, kind, text)), order, ratings); + list.innerHTML = listHtml(shown, ratings); root.querySelector("[data-mod-count]").textContent = `${shown.length} of ${projects.length}`; root.querySelectorAll("[data-kind-filter]").forEach((b) => b.setAttribute("aria-pressed", String(b.dataset.kindFilter === kind))); } +function showRate(p, message = "") { + const rate = root.querySelector("#mod-rate"); + if (!rate || me === undefined) return; + rate.innerHTML = rateHtml(p, me, mine) + (message ? `

${escape(message)}

` : ""); +} + function showProject() { const p = projects.find((x) => x.id === id); const page = root.querySelector(".mod-page, .mod-missing"); if (!page) return; if (p) { - page.outerHTML = projectHtml(p); + page.outerHTML = projectHtml(p, ratings ? ratingOf(ratings, p.id) : undefined); document.title = `${p.name} · Horizon`; + showRate(p); } else { page.outerHTML = `

Not in the registry

No project is called ${id} here. It may not be published yet, or it was taken down.

Every mod
`; } @@ -37,7 +52,56 @@ function render() { else showList(); } -if (!id) { +// The signed-in account and its own rating, for the page's rating control. +async function signIn() { + try { + const r = await fetch(`${API}/me`, { credentials: "same-origin" }); + me = r.ok ? await r.json() : null; + if (me) { + const own = await fetch(`${API}/${id}/rating`, { credentials: "same-origin" }); + mine = own.ok ? (await own.json()).stars : null; + } + } catch { + me = null; + } + const p = projects.find((x) => x.id === id); + if (p) showRate(p); +} + +async function rate(stars) { + const p = projects.find((x) => x.id === id); + if (!p || !me) return; + root.querySelectorAll(".mod-star").forEach((b) => (b.disabled = true)); + let message = ""; + try { + const r = await fetch(`${API}/${id}/rating`, { + method: "POST", + credentials: "same-origin", + headers: { "Content-Type": "application/json", "X-CSRF-Token": me.csrf }, + body: JSON.stringify({ stars }), + }); + const json = await r.json().catch(() => ({})); + if (r.ok) { + mine = json.stars; + ratings = { ...ratings, [id]: { average: json.average, count: json.count } }; + const line = root.querySelector("[data-mod-rating]"); + if (line) line.innerHTML = `${starsHtml(ratingOf(ratings, id))} · `; + } else { + message = json.error || `The service answered ${r.status}.`; + } + } catch { + message = "The service didn't answer. Try again in a minute."; + } + showRate(p, message); +} + +if (id) { + root.addEventListener("click", (e) => { + const star = e.target.closest?.("[data-stars]"); + if (star) rate(Number(star.dataset.stars)); + }); + signIn(); +} else { root.querySelectorAll("[data-kind-filter]").forEach((b) => b.addEventListener("click", () => { kind = b.dataset.kindFilter; @@ -48,8 +112,15 @@ if (!id) { text = e.target.value; showList(); }); - const wanted = new URLSearchParams(location.search).get("kind"); - if (KINDS.some(([k]) => k === wanted)) kind = wanted; + root.querySelector("#mod-sort")?.addEventListener("change", (e) => { + order = e.target.value; + showList(); + }); + const query = new URLSearchParams(location.search); + if (KINDS.some(([k]) => k === query.get("kind"))) kind = query.get("kind"); + if (SORTS.some(([k]) => k === query.get("sort"))) order = query.get("sort"); + const select = root.querySelector("#mod-sort"); + if (select) select.value = order; } setUpTheme(); @@ -64,3 +135,12 @@ cached("horizon:mod-index", () => fetch(INDEX_URL).then((r) => (r.ok ? r.json() } }) .catch(() => {}); +fetch(RATINGS) + .then((r) => (r.ok ? r.json() : Promise.reject(new Error(`${r.status}`)))) + .then((json) => { + if (json && typeof json.projects === "object") { + ratings = json.projects; + render(); + } + }) + .catch(() => {}); diff --git a/website/src/mods.js b/website/src/mods.js index 414db7396..28c31b9fe 100644 --- a/website/src/mods.js +++ b/website/src/mods.js @@ -8,6 +8,8 @@ const REGISTRY = "https://github.com/ludovic111/horizon-mods"; export const SUBMIT = "/mods/submit"; // The submission form's service (crates/horizon-mod-registry), behind the site's own address. export const API = "/api/mods"; +// Every project's ratings: {projects: {: {average, count}}}. +export const RATINGS = `${API}/ratings`; export const SCHEMA = 1; // The kinds the site shows, in the filter's order. Kinds a newer index adds are left out until the site knows them. @@ -43,21 +45,66 @@ const initial = (p) => escape((p.name || p.id).trim().charAt(0).toUpperCase()); const icon = (p) => https(p.icon) ? `` : ``; +// A count as the launcher writes it: 999, 12.3k, 4.1M. +export function count(n) { + if (n < 1000) return String(n); + if (n < 1e6) return `${(n / 1e3).toFixed(1)}k`; + return `${(n / 1e6).toFixed(1)}M`; +} + +const downloads = (p) => { + const n = Number.isSafeInteger(p.downloads) && p.downloads > 0 ? p.downloads : 0; + return `${count(n)} download${n === 1 ? "" : "s"}`; +}; + +// A project's ratings from the service's answer, or null when it has none. +export function ratingOf(ratings, id) { + const r = ratings?.[id]; + return r && Number.isFinite(r.average) && Number.isSafeInteger(r.count) && r.count > 0 ? r : null; +} + +// Five stars, the mean's nearest whole number of them filled, and the mean and count beside. +export function starsHtml(r) { + if (!r) return `No ratings yet`; + const on = Math.min(5, Math.max(0, Math.round(r.average))); + const mean = r.average.toFixed(1); + return `Rated ${mean} out of 5 ${mean} (${count(r.count)})`; +} + +// The list's orders: the most downloaded first (the default), the best rated, or by name. +export const SORTS = [ + ["downloads", "Most downloaded"], + ["rating", "Best rated"], + ["name", "Name"], +]; + +export function sorted(projects, by, ratings) { + const avg = (p) => ratingOf(ratings, p.id)?.average || 0; + const votes = (p) => ratingOf(ratings, p.id)?.count || 0; + const name = (a, b) => a.name.localeCompare(b.name); + const order = { + downloads: (a, b) => (b.downloads || 0) - (a.downloads || 0) || name(a, b), + rating: (a, b) => avg(b) - avg(a) || votes(b) - votes(a) || name(a, b), + name, + }[by] || (() => 0); + return [...projects].sort(order); +} + export function matches(p, kind, text) { if (kind !== "all" && p.kind !== kind) return false; const hay = `${p.id} ${p.name} ${p.summary} ${(p.authors || []).join(" ")}`.toLowerCase(); return text.toLowerCase().split(/\s+/).filter(Boolean).every((w) => hay.includes(w)); } -// The list: a row per project, newest version and kind on the right. -export function listHtml(projects) { +// The list: a row per project; its kind, ratings (once `ratings` is known), downloads and newest version on the right. +export function listHtml(projects, ratings = null) { if (!projects.length) return `

Nothing here yet. Submit yours.

`; return projects .map( (p) => ` ${icon(p)} ${escape(p.name)}${escape(p.summary || "")} - ${escape(KIND_NAMES[p.kind] || p.kind)}${escape(p.versions[0].version)} · ${escape((p.authors || []).join(", "))} + ${escape(KIND_NAMES[p.kind] || p.kind)}${ratings ? `${starsHtml(ratingOf(ratings, p.id))} · ` : ""}${downloads(p)}${escape(p.versions[0].version)} · ${escape((p.authors || []).join(", "))} `, ) .join("\n"); @@ -92,8 +139,19 @@ export function ownersHtml(p) { return `

Published by ${links}

`; } -// One project's page. -export function projectHtml(p) { +// The rating control under a project's ratings: five stars to press when signed in (`mine`, the account's own +// rating, pressed), a sign-in link when not, a note for the project's owners. +export function rateHtml(p, me, mine) { + if (!me) return `Sign in with GitHub to rate`; + if ((p.owners || []).some((o) => o.toLowerCase() === String(me.login).toLowerCase())) return `

You publish it: players rate it.

`; + const stars = [1, 2, 3, 4, 5] + .map((n) => ``) + .join(""); + return `${mine ? "Your rating" : "Rate it"}${stars}`; +} + +// One project's page; `rating` is its ratings (null: none yet), left out when they aren't known. +export function projectHtml(p, rating) { const v = p.versions[0]; const caps = v.capabilities || []; const capsHtml = caps.length @@ -108,7 +166,9 @@ export function projectHtml(p) { return `
${icon(p)}

${escape(KIND_NAMES[p.kind] || p.kind)}${escape((p.authors || []).join(", "))}

${ownersHtml(p)}

${escape(p.name)}

${escape(p.summary || "")}

-

${trust(p)} ${escape(p.license)} ${escape(v.version)}${v.side ? ` ${escape(v.side)}` : ""}

+

${trust(p)} ${escape(p.license)} ${escape(v.version)}${v.side ? ` ${escape(v.side)}` : ""}

+

${rating === undefined ? "" : `${starsHtml(rating)} · `}${downloads(p)}

+
${p.description ? `
${markdown(p.description)}
` : ""} ${p.kind === "mod" ? `

What it may do

${capsHtml}

Mods run in a sandbox with no file, network or clock access. The game refuses a mod whose code uses more than this list.

` : ""} ${requires} diff --git a/website/src/mods.test.mjs b/website/src/mods.test.mjs index c5ff2e783..d94cc3e07 100644 --- a/website/src/mods.test.mjs +++ b/website/src/mods.test.mjs @@ -1,6 +1,6 @@ import { test } from "node:test"; import assert from "node:assert/strict"; -import { CAPABILITIES, entryFrom, listHtml, matches, projectHtml, readIndex, submitHtml } from "./mods.js"; +import { CAPABILITIES, count, entryFrom, listHtml, matches, projectHtml, rateHtml, ratingOf, readIndex, sorted, starsHtml, submitHtml } from "./mods.js"; const project = (over = {}) => ({ id: "coords_hud", kind: "mod", name: "Coordinates HUD", summary: "Where you are.", authors: ["Horizon"], @@ -61,3 +61,50 @@ test("a project's page links its owners' GitHub profiles, and only valid logins" for (const bad of ["bad login", "github.com/-x", "a--b", "