-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Open
Labels
docsDocumentation-related issuesDocumentation-related issues
Description
I promised some people I'd write these up so they can be addressed. This stems mostly from a recent comp.emulators.apple2 thread "MAME 0.222 Apple II highlights".
Some of this may be covered in the latest docs, but I wanted in particular to cover all of Andy McFadden's pain points because he wanted to use MAME, and did, but had a lot of trial and error.
- How to set up ROMs needs to make it clear that you should leave them zipped or 7zipped.
- The fuzzy matching for set names needs to be documented as an option to find games.
- The default keys documentation (https://docs.mamedev.org/usingmame/defaultkeys.html) lists keys for navigating MAME's user interface, but crucially, doesn't mention the default keys for actually playing games (1 for start, 5 for coin, and so on).
- There's some useful user-written debugger documentation here that we might want to incorporate: https://6502disassembly.com/mame-dbg.html
Metadata
Metadata
Assignees
Labels
docsDocumentation-related issuesDocumentation-related issues
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
Firehawke commentedon Aug 21, 2020
Added to list of things I'll be working on.
Firehawke commentedon Aug 22, 2020
A few points for @rb6502:
The docs already do say .zip in many places in the "Using MAME" section. I'm adding an additional reference at the top to make sure people see it. In fact, the last line on ROMs and CHDs specifically says not to compress a CHD to ZIP/7Z like you would ROM sets. When I get ready to PR this whole set, I'll tag you so you can take a look.
I'm redoing the key tables now. That part's going to take a bit since I'm reformatting the tables entirely and RST tables are a little bit of a pain, especially at this size.
I'll look into the debugger stuff when I get the tables done.
rb6502 commentedon Aug 22, 2020
Thanks, I appreciate it!
Firehawke commentedon Sep 13, 2020
Key tables have been updated locally, but I'm expecting a desire for further changes per usual. I'll be putting in a PR very soon to allow @rb6502 and @cuavas to put in opinions.
Covering other elements from the conversation:
rb6502 commentedon Sep 13, 2020
Great, looking forward to it.
atan2005 commentedon Aug 9, 2021
I have read the MAME Documentation 0.227 and I have found some errors. I have just joined github today and is this the right place to report them?
stilett0 commentedon Aug 9, 2021
May as well.