From db8eb668a0b6b3cc9d17f6e906672c74f71f7386 Mon Sep 17 00:00:00 2001 From: EmulationFanatic <62343878+EmulationFanatic@users.noreply.github.com> Date: Wed, 30 Dec 2020 00:43:38 -0700 Subject: [PATCH] Update README.MD with clear instructions. Added status label cheat sheet. --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index da6ae0a..d3d2e57 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ # Ryujinx Games Compatibility List -Anyone is free to update or share their results here. +Anyone is free to update or share their results here, with the following requirements: +- You must use an official master build with the "Ignore Missing Services" feature DISABLED +- Follow the new issue template and remove any unnecessary text, but please leave all formatting intact. +- Search for a game first before adding a new issue; if you find an existing issue that is out of date, reply to it with a copied/pasted new issue template. A curator will then edit the OP with your test data. -All game states should be handled in issues but you need to follow the issue template to ensure they're valid. -When you update or add some feedback, please, be as accurate as possible. +When you update or add additional information in an issue, please reply to the issue indicating your changes. -Thanks. +A curator will apply appropriate labels to the issue. Our criteria may be a tad more stringent than some other emulator compatibility lists, (and this may eventually change one day), but for now, see the status label cheat sheet. + +**Status label cheat sheet**: +- status-playable - Boots and plays without any crashes or gpu bugs of any kind, and at a speed fast enough to reasonably enjoy on an average PC. +- status-ingame - Boots and goes in-game but suffers from one or more of the following: crashes, deadlocks, gpu bugs, distractingly bad audio, or is simply too slow. Game still might able to be played all the way through, but not as the game is intended to play. +- status-menus - Boots and goes past the title screen but does not make it into main gameplay. +- status-boots - Boots but does not make it past the title screen. +- status-nothing - Does not boot/shows no signs of life.