Update FAQ: Fix broken links, update ISO integrity instructions, cleanup for clarity#21
Update FAQ: Fix broken links, update ISO integrity instructions, cleanup for clarity#21deltaryz wants to merge 9 commits intoProject-Plus-Development-Team:masterfrom
Conversation
FunctionDJ
left a comment
There was a problem hiding this comment.
see comments. also please run the formatter.
| <hr /> | ||
| <section> | ||
| <HA2 id="os-support"> | ||
| Can I run Project+ on Windows/Mac/Linux/Steam Deck? |
There was a problem hiding this comment.
i guess steam deck support is kind of correct with the linux build, but i don't think it's as easy as win/mac and regular desktop linux distros, so i'm hesitant to mention steam deck.
There was a problem hiding this comment.
Would you like me to write a dedicated steam deck section? I have a steam deck myself so I can make sure it's correct & works for a fresh install.
There was a problem hiding this comment.
not in this PR. you're welcome to open a separate PR for that after this one is merged.
| Unfortunately, Project+ does not have matchmaking like Slippi. Most | ||
| matchmaking happens through <a href="https://discord.gg/vdssRDg">Discord.</a> |
There was a problem hiding this comment.
since the P+ discord is mostly used by the north-american communities for matchmaking, i think we shouldn't add it's link to th "Discord" word here.
| https://github.com/jlambert360/FPM-AppImage/releases | ||
| </a> | ||
| To play Project+ on PC with Dolphin (Netplay supported), see the{" "} | ||
| <a href="https://www.smashladder.com/guides/view/27jj/project-m/project-v2-netplay-guide">Dolphin Netplay Guide</a>. |
There was a problem hiding this comment.
now THAT is an ancient guide...
let's not reference it anymore.
There was a problem hiding this comment.
Do you have a specific recommendation for a newer guide, or should we just stick to the video on the download page?
(Personally I'd really prefer to have a text guide as well, but you're right that one is old)
There was a problem hiding this comment.
| <hr /> | ||
| <section> | ||
| <HA2 id="iso-compatible">How do I know my Brawl ISO is compatible?</HA2> | ||
| <img src="https://i.imgur.com/qNOMtx0.png"></img> |
There was a problem hiding this comment.
resources should not be loaded from a third party and instead be in this repository.
i know there was an imgur link before with a screenshot, but that was also suboptimal.
There was a problem hiding this comment.
Where should the image be placed in the repo? I did try doing that but I kept the imgur approach because I couldn't discern what the right place to put the asset would be
There was a problem hiding this comment.
see app/knuckles/page.tsx (import images from "~image-indexes/knuckles";) and the generate-imgs script in package.json
| <li>52ce7160ced2505ad5e397477d0ea4fe</li> | ||
| <li>d8560b021835c9234c28be7ff9bcaaeb</li> | ||
| <li>5052e2e15f22772ab6ce4fd078221e96</li> | ||
| <li>52ce7160ced2505ad5e397477d0ea4fe</li> | ||
| <li>9f677c78eacb7e9b8617ab358082be32</li> |
There was a problem hiding this comment.
why change the order of the MD5s here..?
There was a problem hiding this comment.
I honestly forget why I did that.
Related to this, something I considered was changing out MD5 for SHA1 since Dolphin doesn't check MD5 by default. However, I don't have 5 different matching brawl dumps, so I can't get the SHA1 equivalents for all of these.
There was a problem hiding this comment.
then we'll stick with md5
| <li>1c4d6175e3cbb2614bd805d32aea7311</li> | ||
| </ul> | ||
| <p> | ||
| If your game is not working, and the hash isn't listed here, it is |
There was a problem hiding this comment.
i think the "if your game is not working" bit needs to be kept, since that's the symptom players may experience if they have a bad dump.
There was a problem hiding this comment.
In that case, let's be even more specific - "If Project+ is not working"
this covers things like vanilla brawl booting instead of project+, more clear than the nebulous "game"
| Click here for Smashladder's Controller Guide. | ||
| </a> | ||
| Click here | ||
| </a> for Smashladder's Controller Guide. |
| <hr /> | ||
| <h4>Can I play Project+ on an M1 Mac (ARM)?</h4> | ||
| <HA2 id="m1-mac">Can I play Project+ on an M1 Mac (ARM)?</HA2> | ||
| <p> | ||
| We are planning to swap the base of our Dolphin build sometime in the | ||
| future to restore Mac compatibility. M1 and beyond Macs will not be |
There was a problem hiding this comment.
if it's a HA2 it should be wrapped in a section
| <li>Check <code>Calculate</code> near the MD5 box at the bottom</li> | ||
| <li>Click the <code>Verify Integrity</code> button and wait for analysis to complete.</li> | ||
| </ul> | ||
| <p>Compatible <code>MD5</code> hashes may include:</p> |
These instructions are outdated and no longer represent the current menu layout of Dolphin (neither mainline nor Project+ fork).
Many links were broken and led to a broken page, and there were some minor formatting inconsistencies and missing dividers