From 70fbba4f65fc161df4a60bf1f37d373eb9a7f3a2 Mon Sep 17 00:00:00 2001 From: simpledemon <153544772+simpledemonn@users.noreply.github.com> Date: Thu, 4 Apr 2024 21:16:04 +0200 Subject: [PATCH] Cook the incompatible mod list - Move the endpoint inside the API (with redirect) - Add icons, status, and tracking issues - Remove old entries that are already fixed - Make a HTML view for the page --- package.json | 5 +- public/_redirects | 20 +-- public/api/v1/incompatible-mods.json | 135 +++++++++++++++++ public/assets/img/unknown.png | Bin 0 -> 1655 bytes public/incompatible-mods.json | 136 ------------------ .../atoms/IncompatibleModCard.astro | 71 +++++++++ src/layouts/KnownIncompatibilities.astro | 53 +++++++ .../en/usage/known-incompatibilities.mdx | 6 + 8 files changed, 279 insertions(+), 147 deletions(-) create mode 100644 public/api/v1/incompatible-mods.json create mode 100644 public/assets/img/unknown.png delete mode 100644 public/incompatible-mods.json create mode 100644 src/components/atoms/IncompatibleModCard.astro create mode 100644 src/layouts/KnownIncompatibilities.astro create mode 100644 src/pages/en/usage/known-incompatibilities.mdx diff --git a/package.json b/package.json index b41a7c8f0..d574a78b2 100644 --- a/package.json +++ b/package.json @@ -25,6 +25,7 @@ "i18next": "^21.10.0", "i18next-fluent": "^2.0.0", "i18next-fs-fluent-backend": "github:pluiedev/i18next-fs-fluent-backend", + "marked": "^12.0.1", "node-fetch": "^3.3.2", "quilt-bulma": "0.0.23", "rehype-autolink-headings": "^6.1.1", @@ -39,6 +40,6 @@ "semver-sort": "^1.0.0" }, "engines": { - "node": ">=20" - } + "node": ">=20" + } } diff --git a/public/_redirects b/public/_redirects index fd4849b83..621d1219b 100644 --- a/public/_redirects +++ b/public/_redirects @@ -1,10 +1,12 @@ -/faq /about/faq 308 -/community/moderation /staff/moderation/moderation 308 -/community/tupperbox /community/pluralkit 308 -/blog /blog/1 308 -/qsl https://modrinth.com/mod/qsl 308 +/qsl https://modrinth.com/mod/qsl 308 +/incompatible-mods.json /api/v1/incompatible-mods.json 308 -/en/faq /about/faq 308 -/en/community/moderation /staff/moderation/moderation 308 -/en/community/tupperbox /community/pluralkit 308 -/en/blog /blog/1 308 +/faq /about/faq 308 +/community/moderation /staff/moderation/moderation 308 +/community/tupperbox /community/pluralkit 308 +/blog /blog/1 308 + +/en/faq /about/faq 308 +/en/community/moderation /staff/moderation/moderation 308 +/en/community/tupperbox /community/pluralkit 308 +/en/blog /blog/1 308 diff --git a/public/api/v1/incompatible-mods.json b/public/api/v1/incompatible-mods.json new file mode 100644 index 000000000..6f981b065 --- /dev/null +++ b/public/api/v1/incompatible-mods.json @@ -0,0 +1,135 @@ +[{ + "ids": ["better_loading_screen"], + "name": "Better Loading Screen", + "type": "GAME", + "status": "WONT_FIX", + "tracking": "https://github.com/shedaniel/BetterLoadingScreen/issues/20", + "icon": "https://media.forgecdn.net/avatars/511/148/637829105007128197.png" + }, + + { + "ids": ["bigbeacons"], + "name": "Big Beacons", + "type": "GAME", + "status": "UNKNOWN", + "tracking": "UNKNOWN", + "icon": "https://media.forgecdn.net/avatars/348/332/637499126404745895.png" + }, + + { + "ids": ["decorative_blocks"], + "name": "Decorative Blocks", + "type": "GAME", + "status": "IN_PROGRESS", + "tracking": "https://github.com/lilypuree/Decorative-Blocks/issues/76", + "icon": "https://media.forgecdn.net/avatars/248/967/637171183613258353.png" + }, + + { + "ids": ["logbegone"], + "name": "Log Begone", + "type": "SELF", + "status": "BLOCKED", + "tracking": "https://github.com/AzureDoom/Log-Begone/issues/3", + "note": "Not all log messages are passed through the mod's filter.", + "icon": "https://media.forgecdn.net/avatars/557/92/637903174661344067.png" + }, + + { + "ids": ["vulkanmod"], + "name": "VulkanMod", + "type": "GAME", + "status": "NO_ANSWER", + "tracking": "https://github.com/xCollateral/VulkanMod/issues/204", + "icon": "https://cdn.modrinth.com/data/JYQhtZtO/05e927ce5f83fd03e9575441d18707d8bd72437d.png" + }, + + { + "ids": ["codex"], + "name": "Codex", + "type": "GAME", + "status": "WONT_FIX", + "tracking": "https://github.com/IMB11/Codex/issues/3", + "icon": "https://media.forgecdn.net/avatars/893/179/638335912397170484.png" + }, + + { + "ids": ["libjf"], + "name": "LibJF", + "type": "GAME", + "status": "ON_HOLD", + "tracking": "https://github.com/Fabulously-Optimized/fabulously-optimized/issues/210#issuecomment-1232601249", + "icon": "https://media.forgecdn.net/avatars/382/525/637566912042948257.png" + }, + + { + "ids": ["optifabric", "optifine"], + "name": "OptiFabric/OptiFine", + "type": "GAME", + "status": "NO_ANSWER", + "tracking": "https://github.com/Chocohead/OptiFabric/issues/751", + "icon": "https://media.forgecdn.net/avatars/204/621/636941511294490034.png" + }, + + { + "ids": ["rpgdifficulty"], + "name": "Rpg Difficulty", + "type": "GAME", + "status": "WONT_FIX", + "tracking": "https://github.com/Globox1997/RpgDifficulty/issues/39", + "icon": "https://media.forgecdn.net/avatars/380/837/637563157215396535.png" + }, + + { + "ids": ["fldf"], + "name": "Fast Leaf Decay", + "type": "GAME", + "status": "UNKNOWN", + "tracking": "UNKNOWN", + "note": "Tries to crash the game as part of a targeted harassment campaign against Quilt and its users.", + "icon": "https://quiltmc.org/assets/img/unknown.png" + }, + { + "ids": ["dynmap"], + "name": "Dynmap", + "type": "GAME", + "status": "WONT_FIX", + "tracking": "https://github.com/webbukkit/dynmap/issues/4016", + "icon": "https://media.forgecdn.net/avatars/467/189/637748639594181930.png" + }, + { + "ids": ["chattriggers"], + "name": "ChatTriggers", + "type": "SELF", + "status": "UNKNOWN", + "tracking": "UNKNOWN", + "note": "Modules can be loaded and managed, but are unable to be executed on Quilt.", + "icon": "https://media.forgecdn.net/avatars/497/51/637812567601108749.png" + }, + { + "ids": ["creativecore"], + "name": "CreativeCore", + "type": "WORKAROUND", + "status": "WONT_FIX", + "tracking": "https://github.com/CreativeMD/CreativeCore/issues/205", + "note": "Occasionally breaks the search tab in the creative mode item screen, and spams errors in logs. The issue can be fixed via using its `/cmdclientconfig` command to set `playSoundWithOffset` to `false`.", + "icon": "https://media.forgecdn.net/avatars/86/225/636207446427836220.png" + }, + { + "ids": ["wetlands"], + "name": "Beneath the Wetlands", + "type": "GAME", + "status": "NO_ANSWER", + "tracking": "https://github.com/birchfolks/Beneath-the-Wetlands/issues/13", + "icon": "https://media.forgecdn.net/avatars/953/375/638444045210140536.png" + }, + { + "ids": ["essential-container"], + "name": "Essential", + "type": "WORKAROUND", + "status": "WONT_FIX", + "tracking": "https://gist.github.com/OroArmor/66632962acdd4bbbacc71d858befab29", + "note": "Prevents Quilt clients from connecting to local worlds on 1.20.2+. Add `-Dquilt.networking.reserialize_custom_payloads=true` to the java arguments. Provided direct help to developers and was turned down. Issue on their end. Will also not be present in Mod Menu.", + "icon": "https://media.forgecdn.net/avatars/597/210/637973904487237935.png" + } +] diff --git a/public/assets/img/unknown.png b/public/assets/img/unknown.png new file mode 100644 index 0000000000000000000000000000000000000000..29ff4ff725caaacf6520e32e05f34f2d4f01440f GIT binary patch literal 1655 zcmV--28j8IP)%^XJ==IhK8A$nP6aGX=!Pinwo%sfPQ{{ zi;Ig}TU(Wtm5`8-Z*OmQc6OGQmU41(jEsz8Vq$}XgIZczV`F28h=_uMf_Qj%j*gCv zjg5hUfr*KUb#--fb8}{9W@~F}aBy&6UtfB9dW3|8dwY9sZf+#MLHqy!1vp7WK~#90 z?V0~m8b=hsZ(&)`K|llrg2mV~SFA=SG1X{0{h|MMXF45Qzs4pt7-Om?w#KjEH%QPs z3reTwy)Na6Y9R*YTE&Z z-&LqYGVjy5#@$i0OV=WU(Tm#v#?cO)h@@YthJPL*kdB&tVfhi3fWYWF?R4g==KpXe zutR&pXt5=LsP?>~z2Lwz)=Q$P9Q`U8k1uh*f(O9WkrS$#7Gj=x9;IWDBIY<_IDpZU zGX&GWvG8qpa>)<#ME_QqLzn>R5Zn&Iv1@BpM>A`5sGPnx&lDu%UVjpVpFGW5&R%PH zdIcsK%>nvqhUy`k!@V+gE5?g=$LVFsks3wkTt`P;Rl>Gk%*Muj4LefuT{ zWdw+kbLwa0>9tcgTchYZfK`jd7Yz>@0OFp9b|%V&O&8PaZKQZW9h4e>#|1pPsu^eG zV$jCHuo|xZ_-9Q{;rCp?WR6}&Lp-yw0z7_0rQ`r0kV=tlHvBeya0ERk08Jgjr!GPV zp)avc>U}$aOh=NjP20_+-o!+i>OUzFd%)wvLoohGvy)~{A5q^@E0`!(HtYeOi_!cQ zn9Vl}_Dccbm>?*LuH1L8oB%XGdk|C_nxk_J(1xjAF#gOcC!ogN9Vc`M$}Z3$E&!TlFC(f@lbg)VB&B*`&+9p<8>TCO zW}9!RlO*>GyXKGRlL}Obk&ED`ZNMEs53zRXyGMq8HK?ol=Ij=m+o%nXU!Hcew{>`&Bl5QJFhj7}I#7dM3Q*dmB6 zs=hQ2Z4DrV2eu)^dOG{0W0fwvSY^bFEdn$-`9hE(C{%T&=+7+GZ5bfo2c?qSxRR$f z*eO)&0NrjIS=z)pFGITxKo9ta^k_R?I_8bIB|uXgZCS~g#V&DMK&H?Jv;l2E8_))P zAprj=e*znTlanmJxIKGsxi@s1QA>L;(8 zmVyny-QUhZCUL%E4#ybvqErAvQTbufBqt`o>xT-5Dy}tuG_&G0yakz8GBIlhkP`Ed zSf{J30tCBeCl08zR7sv3|6v6{(qX;$CK=zw8la^ZsWn)NWd4)NngDomsf$VzDQQmq zhg&zrlf`Wq^7N>VFaoBR36v)9&2meV7L{M|ewE5ep56kLy$L`+K_Vj0$cy}J-LkZd zrdFVaa)rxA0FI17K{{vHIeC;vcQxLb{?jE4E{s)Fr2y!{-urTTPpbigtb{ZE_;CH9bxj4%li9&rPsWjDI zJ_`V9;I69XZqJjY6MU+;J5Y89XrZ+MZNUEk@Gs +
+
+
+
+
+ Mod icon +
+
+
+

{mod.name}

+

{mod.ids.join(', ')}

+
+
+
+ +
+ { + (mod.tracking === "UNKNOWN") ? ( + + + + ) : ( + + + + ) + } +
+
+ + { + (mod.note) && ( +
+

+
+ ) + } +
+
+ \ No newline at end of file diff --git a/src/layouts/KnownIncompatibilities.astro b/src/layouts/KnownIncompatibilities.astro new file mode 100644 index 000000000..16596cafe --- /dev/null +++ b/src/layouts/KnownIncompatibilities.astro @@ -0,0 +1,53 @@ +--- +import Page from "./Page.astro"; + +import rawData from "../../public/api/v1/incompatible-mods.json"; +import IncompatibleModCard from "../components/atoms/IncompatibleModCard.astro"; + +const TYPE_TO_HUMAN = { + "GAME": "Breaks the game", + "OTHERS": "Breaks other mods", + "WORKAROUND": "Requires a workaround", + "SELF": "Non-fatal errors or broken features" +} + +const props = Astro.props; +const data = rawData.sort((a, b) => a.name.localeCompare(b.name)) +--- + +

On this page you may find all the reported incompatibilities with Quilt. If you believe this list is missing anything, please feel free to tell us on Discord.

+ +

Requires a workaround

+

This is the simplest form of problems, the issue can simply be fixed by following the instructions provided.

+ { + data.filter(mod => mod.type === "WORKAROUND").map((mod) => ( + + )) + } + +

Non-fatal errors or broken features

+

These mods are not compatible with Quilt, but they do not break the game or other mods. They may have broken features or other errors that do not crash the game.

+ { + data.filter(mod => mod.type === "SELF").map((mod) => ( + + )) + } + +

Breaks other mods

+

These mods are not compatible with Quilt, and they break other mods.

+ { + data.filter(mod => mod.type === "OTHERS").map((mod) => ( + + )) + } + +

Breaks the game

+

These mods are not compatible with Quilt, and they break the game.

+ { + data.filter(mod => mod.type === "GAME").map((mod) => ( + + )) + } + +

This data is also available in machine-readable format at /api/v1/incompatible-mods.json.

+ diff --git a/src/pages/en/usage/known-incompatibilities.mdx b/src/pages/en/usage/known-incompatibilities.mdx new file mode 100644 index 000000000..94d9d861f --- /dev/null +++ b/src/pages/en/usage/known-incompatibilities.mdx @@ -0,0 +1,6 @@ +--- +permalink: /usage/ +title: Known Incompatibilities +description: See all the known incompatibilities with Quilt in this page. +layout: /src/layouts/KnownIncompatibilities.astro +---