MAME Documentation

Note

This documentation is a work in progress. You can track the status of these topics through MAME's issue tracker. Learn how you can contribute.

• What is MAME
• Health Warnings
• Getting MAME prepared
  • An Introduction to MAME
  • Purpose of MAME
  • Systems Emulated by MAME
  • Supported OS
  • System Requirements
  • BIOS Dumps and Software
  • Installing MAME
  • Compiling MAME
  • Configuring MAME
• Basic MAME Usage and Configuration
  • Using MAME
  • MAME’s User Interface
  • Default Keyboard Controls
  • MAME Menus
  • How does MAME look for files?
  • Front-ends
  • About ROMs and Sets
  • Common Issues and Questions (FAQ)
• MAME Command-line Usage and OS-Specific Configuration
  • Universal Command-line Options
  • Windows-Specific Command-line Options
  • SDL-Specific Command-line Options
  • Command-line Index
• Plugins
  • Autofire Plugin
  • Console Plugin
  • Data Plugin
  • Discord Presence Plugin
  • Dummy Test Plugin
  • GDB Stub Plugin
  • Hiscore Support Plugin
  • Input Macro Plugin
  • Layout Plugin
  • Timecode Recorder Plugin
  • Game Play Timer Plugin
• Advanced configuration
  • Multiple Configuration Files
  • MAME Path Handling
  • Shifter Toggle Disable
  • BGFX Effects for (nearly) Everyone
  • HLSL Effects for Windows
  • GLSL Effects for *nix, OS X, and Windows
  • Controller Configuration Files
  • Stable Controller IDs
  • Linux Lightguns
• MAME Debugger
  • General Debugger Commands
  • Memory Debugger Commands
  • Execution Debugger Commands
  • Breakpoint Debugger Commands
  • Watchpoint Debugger Commands
  • Registerpoint Debugger Commands
  • Exceptionpoint Debugger Commands
  • Code Annotation Debugger Commands
  • Cheat Debugger Commands
  • Media Image Debugger Commands
• Lua Scripting Interface
  • Lua Common Types and Globals
  • Lua Core Classes
  • Lua Device Classes
  • Lua Memory System Classes
  • Lua Input System Classes
  • Lua Render System Classes
  • Lua Debugger Classes
• MAME External Tools
  • chdman – CHD (Compressed Hunks of Data) File Manager
  • Imgtool - A generic image manipulation tool for MAME
  • Imgtool Format Info
  • Castool - A generic cassette image manipulation tool for MAME
  • Floptool - A generic floppy image manipulation tool for MAME
  • Other tools included with MAME
  • Developer-focused tools included with MAME
• Contributing to MAME
  • C++ Coding Guidelines
  • Guidelines for Software Lists
• Technical Specifications
  • MAME Naming Conventions
  • MAME Layout Files
  • MAME Layout Scripting
  • Object Finders
  • Input System
  • The device_memory_interface
  • The device_rom_interface
  • The device_disasm_interface and the disassemblers
  • The device_sound_interface
  • Emulated system memory and address spaces management
  • CPU devices
  • The new floppy subsystem
  • The new SCSI subsystem
  • The new 6502 family implementation
  • UML Instruction Reference
  • Software 3D Rendering in MAME
  • Audio effects
  • OSD audio support
• MAME and security concerns
• The MAME License

Contribute

The documentation on this site is the handiwork of our many contributors.