The-Homebrew-Cloud/azahar-compatibility-list
2
0
Fork 0
mirror of https://github.com/azahar-emu/compatibility-list.git synced 2025-03-06 19:15:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added report contribution instructions and template

Browse Source
This commit is contained in:
OpenSauce04 2024-05-27 14:44:32 +01:00
parent 29291d4175
commit a052abfe4d
4 changed files with 122 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
.github/ISSUE_TEMPLATE/compat_report.yml vendored Normal file
View File

@ -0,0 +1,64 @@
name: Compatibility Report
description: Report the compatibility of a game
body:
- type: markdown
attributes:
value: Tech support does not belong here; This page is for submitting compatibility reports with a correctly set up emulator.
- type: checkboxes
attributes:
label: Prerequisites
options:
- label: I have checked there is no currently open report for this game. (An updated report can be made for games with previously closed reports).
required: true
- label: I have read through the contribution guide [here](https://github.com/Lime3DS/compatibility-list/blob/master/CONTRIBUTING.md) from start to finish.
required: true
- label: I have played through this game from start to finish only using official releases of the Lime3DS emulator.
required: true
- label: The OpenGL renderer was used for my entire playthrough.
required: true
- type: dropdown
id: rating
attributes:
label: Rating
description: What is the compatibility rating you are reporting for the game?
options:
- --Select One--
- Perfect
- Great
- Okay
- Bad
- Intro/Menu
- Won't Boot
validations:
required: true
- type: textarea
id: report-desc
attributes:
label: Description
description: An in-depth description of the playthrough experience when using the emulator, including any issues which were experienced. Include screenshots and videos if available and relevant.
validations:
required: true
- type: input
attributes:
label: Lime3DS Version
description: The Lime3DS version which was used when playing through the game. If multiple versions were used, list them all.
placeholder: "1234"
validations:
required: true
- type: textarea
id: system-config
attributes:
label: System Configuration
description: Information about your system. If using Linux, include whether you are using Flatpak or AppImage
placeholder: |
CPU: Intel i5-10400 / AMD Ryzen 5 3600
GPU/Driver: NVIDIA GeForce GTX 1060 (Driver 512.95)
RAM: 16GB DDR4-3200
OS: Windows 11 22H2 (Build 22621.819)
value: |
CPU:
GPU/Driver:
RAM:
OS:
validations:
required: true

4
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,4 @@
blank_issues_enabled: false
contact_links:
- name: Lime3DS Discord
url: https://discord.com/invite/4ZjMpAp3M6

52
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,52 @@
# Contributing Compatibility Reports
## Preamble
Before beginning, please check that there isn't an existing open compatibility report for the game. Only one report should be active for a single game at any given time. New reports can be made for games which have previously closed reports to provide an updated compatibility score.
Additionally, please do not create a report for a game with the same compatibility rating that it already has. These reports are redundant and will be closed without further communication.
## Starting the Report
To begin creating a report, [open a new Compatibility Report issue form](https://github.com/Lime3DS/compatibility-list/issues/new?assignees=&labels=&projects=&template=compat_report.yml) on the Issues page of this repository
Before contributing a compatibility report, a few criteria must be met which are listed as checkboxes at the top of this form. Please read and ensure that all of these have been met before continuing.
Once you have verified that your report is valid, please title your report with the official name of the game as present in the Lime3DS GUI, alongside the game's title ID. You can acquire the game's title ID by right-clicking on the game in the Lime3DS GUI and then selecting Properties.
An example of a valid report tile would be: "Pokémon X [0004000000055D00]"
## Compatibility Rating
You must now decide which compatibility rating the game will be given. This is determined based on the criteria provided below:
#### ![#5c93ed](https://placehold.co/15x15/5c93ed/5c93ed.png) 0: Perfect
The game functions perfectly, with absolutely no graphical or audio glitches. The experience is identical to real hardware.
#### ![#47d35c](https://placehold.co/15x15/47d35c/47d35c.png) 1: Great
The game functions with minimal graphical or audio glitches which do not affect the gameplay experience. The experience will be close to real hardware with minor inaccuracies.
#### ![#94b242](https://placehold.co/15x15/94b242/94b242.png) 2: Okay
The game functions with major graphical or audio glitches but is still playable from beginning to end. The experience may differ significantly from real hardware due to these issues.
#### ![#f2d624](https://placehold.co/15x15/f2d624/f2d624.png) 3: Bad
The game functions with major graphical or audio glitches, and progress from beginning to end is not possible due to glitches.
#### ![#ff0000](https://placehold.co/15x15/ff0000/ff0000.png) 4: Intro/Menu
The game boots, but crashes when progressing past the start screen. The game is completely unplayable
#### ![#828282](https://placehold.co/15x15/828282/828282.png) 5: Won't Boot
The game instantly crashes on boot without displaying and opening graphics. The game is completely unplayable
## Description
After the score has been decided, you must then write about your experience playing the game in the Description box. This serves to back up your report and explain why the compatibility rating you chose was selected.
Any issues you experienced while playing the game must be described in detail here alongside screenshots or videos if available and relevant.
## System Info
Once this description has been written, please fill out the remaining boxes in the form. This will collect the Lime3DS version(s) which were used during gameplay alongside information about your system.
## Submitting the Report
When all previous forms have been filled out, the "Submit New Issue" button can be pressed.
This will create a new pending report for the game.
Before the report is accepted into the compatibility list, it is required that at least one other user corroborates the report that you have written. There is no official format for this, and the only requirement is that another person agrees that the report accurately reflects their personal experience when playing through the game via a comment.
Once another user has agreed with the report, the issue will be closed by a maintainer and it will be included into the compatibility list.

22
README.md
View File

@ -4,23 +4,5 @@ Compatibility is ranked on a scale from 0 to 5 where the lower the number, the b
Notably, Vulkan is not included in this compatibility list, as it is considered to be in an unstable state. Compatibility reports should only be made against the OpenGL renderer
#### ![#5c93ed](https://placehold.co/15x15/5c93ed/5c93ed.png) 0: Perfect
The game functons perfectly, with absolutely no graphical or audio glitches. The experience is identical to real hardware.
#### ![#47d35c](https://placehold.co/15x15/47d35c/47d35c.png) 1: Great
The game functions with minimal graphical or audio glitches which do not affect the gameplay experience. The experience will be close to real hardware with minor inaccuracies.
#### ![#94b242](https://placehold.co/15x15/94b242/94b242.png) 2: Okay
The game functions with major graphical or audio glitches, but is still playable from beginning to end. The experience may differ significantly from real hardware due to these issues.
#### ![#f2d624](https://placehold.co/15x15/f2d624/f2d624.png) 3: Bad
The game functions with major graphical or audio glitches, and progress from beginning to end is not possible due to glitches.
#### ![#ff0000](https://placehold.co/15x15/ff0000/ff0000.png) 4: Intro/Menu
The game boots, but crashes when progressing past the start screen. The game is completely unplayable
#### ![#828282](https://placehold.co/15x15/828282/828282.png) 5: Won't Boot
The game instantly crashes on boot without displaying and opening graphics. The game is completely unplayable
#### ![#000000](https://placehold.co/15x15/000000/000000.png) 99: Not Tested
The game's compatibility has not yet been reported. Your milage may vary.
## Contributing
For instructions on how to contribute compatibility reports, please read [here](https://github.com/Lime3DS/compatibility-list/blob/master/CONTRIBUTING.md)