Go to file
Vas Crabb 3e3d27dde5 Started moving UML instruction reference to main documentation, fixed more recompiler issues:
* cpu/drcbearm64.cpp Interpret index operand for load and store
  instructions as a signed 32-bit value for consistency with x86-64.
  Moved code to interpret load and scale the index for integer
  load/store to a helper function to make it easier to update if it
  needs changes or fixes.
* cpu/drcbearm64.cpp: Use and/orr to set carry flag directly rahter than
  using an intermediate register when both operands of a CARRY
  instruction are immediates.
* cpu/drcbearm64.cpp: Fixed incorrect operand type assertion for FREAD.
* cpu/drcbearm64.cpp: Use less verbose asmjit helper functions for shift
  operations and addressing modes.
* cpu/drcbex64.cpp: Interpret index operand for floating point
  load/store as a signed 32-bit value for consistency with integer
  load/store.
* cpu/drcbex64.cpp: Guard against any possibility of load and store
  instructions altering the flags.
* cpu/drcbex64.cpp: Reduced copy/paste in floating point load/store
  instructions.
* cpu/drcbex64.cpp: Cleaned up some casts between integer types with
  differing size and signedness.
* docs: Added reference for UML flow control, data movement and emulated
  memory access instructions.
* cpu/uml.cpp: Truncate immediates to size for a few more instructions.
* cpu/uml.cpp: Added SPACE_OPCODES since it's a well-known address space
  now.
* cpu/uml.cpp: Removed SCALE_DEFAULT.  It's unimplemented by back-ends
  and unused by front-ends.
* cpu/uml.h, cpu/drcumlsh.h: Less confusing names for parameters to read
  and write instruction generators.
* cpu/drcbex86.cpp: Templated 64-bit multiplication helpers on the
  zero/sign flag source, cleaned up casting pointers to integers.
2025-04-12 02:58:15 +10:00
.github docs: Fixed paper size selection (GitHub #13439). Also set paper size to widespread A4 for dist.mak and CI. 2025-03-08 23:26:00 +11:00
3rdparty 3rdparty/zlib: Updated to 1.3.1. (#13505) 2025-03-26 21:52:28 -04:00
android-project Bumped version to 0.276 2025-03-30 10:51:08 +11:00
artwork Swapped R and B channels in lut-default.png, and adjusted D3D9 LUT-application behaviour. (#11004) [Ryan Holtz] 2023-03-20 03:59:44 +11:00
attic multfish.cpp: Added documented game dumps from file outside of SRC tree (attic/multfish.ref) 2022-08-10 20:20:56 -04:00
benchmarks Fix building benchmarks 2021-06-22 14:42:29 +02:00
bgfx Revert "Updated bgfx, bx and bimg to current upstream versions. (#11493)" 2023-09-08 05:14:35 +10:00
ctrlr ctrlr: add xml tag to cfg files 2024-08-06 14:31:12 +02:00
docs Started moving UML instruction reference to main documentation, fixed more recompiler issues: 2025-04-12 02:58:15 +10:00
doxygen debugger: Extended target address syntax to include device/address space. (#8630) 2021-10-01 05:26:11 +10:00
hash megadriv.xml: Added 6 working items (#13485) 2025-04-11 11:27:53 -04:00
hlsl Swapped R and B channels in lut-default.png, and adjusted D3D9 LUT-application behaviour. (#11004) [Ryan Holtz] 2023-03-20 03:59:44 +11:00
ini HLSL Color Transforms and 3D LUT (#4043) 2018-10-07 11:42:30 -04:00
keymaps housekeeping: Use proper SPDX ID for CC0 license. 2022-12-23 02:49:34 +11:00
language Corrected some Chinese UI translations. [aGuGu] 2025-04-09 02:06:37 +10:00
plugins hiscore.dat: Updates 2025-01-25 09:30:13 -06:00
projects
regtests Bump dates to 2023 where appropriate 2023-01-02 11:58:17 +11:00
roms Restore this, it's used when building packages (nw) 2017-10-25 01:34:02 +11:00
samples move some content for release archive out of build repo into main repo 2017-08-14 19:30:35 +10:00
scripts MSX: add Video80 homebrew card (#13568) 2025-04-10 08:10:58 -04:00
src Started moving UML instruction reference to main documentation, fixed more recompiler issues: 2025-04-12 02:58:15 +10:00
tests Bump dates to 2023 where appropriate 2023-01-02 11:58:17 +11:00
web Updated copyright years to 2025 2025-01-01 16:36:28 +11:00
.editorconfig docs: Add naming conventions for certain things. 2020-08-24 13:01:37 +10:00
.gitattributes Tied up loose ends: 2023-12-06 17:31:13 +11:00
.gitignore spi_sdcard: add CMD18 - CMD_READ_MULTIPLE_BLOCK (#8913) 2021-12-01 18:49:48 -05:00
.travis.yml Fix the linux CI, hopefully 2022-11-15 16:27:32 +01:00
CONTRIBUTING.md docs: Added preliminary guide for would-be contributors. (#10717) [Ryan Holtz, Vas Crabb, O. Galibert] 2022-12-22 07:17:55 +11:00
COPYING 3rdparty/expat: Updated to expat 2.6.4. 2025-03-12 17:23:33 +11:00
dist.mak docs: Fixed paper size selection (GitHub #13439). Also set paper size to widespread A4 for dist.mak and CI. 2025-03-08 23:26:00 +11:00
makefile Bumped version to 0.276 2025-03-30 10:51:08 +11:00
README.md README.md: Remove obsolete reference to MESS 2025-01-05 15:20:40 +01:00
uismall.bdf uismall.bdf: Added 57 glyphs (mostly arrow symbols). 2022-02-01 02:07:50 +11:00

MAME

What is MAME?

MAME is a multi-purpose emulation framework.

MAME's purpose is to preserve decades of software history. As electronic technology continues to rush forward, MAME prevents this important "vintage" software from being lost and forgotten. This is achieved by documenting the hardware and how it functions. The source code to MAME serves as this documentation. The fact that the software is usable serves primarily to validate the accuracy of the documentation (how else can you prove that you have recreated the hardware faithfully?). Over time, MAME (originally stood for Multiple Arcade Machine Emulator) absorbed the sister-project MESS (Multi Emulator Super System), so MAME now documents a wide variety of (mostly vintage) computers, video game consoles and calculators, in addition to the arcade video games that were its initial focus.

Where can I find out more?

Community

Development

Alt

CI status and code scanning

CI (Linux) CI (Windows CI (macOS) Compile UI translations Build documentation Coverity Scan Status

How to compile?

If you're on a UNIX-like system (including Linux and macOS), it could be as easy as typing

make

for a full build,

make SUBTARGET=tiny

for a build including a small subset of supported systems.

See the Compiling MAME page on our documentation site for more information, including prerequisites for macOS and popular Linux distributions.

For recent versions of macOS you need to install Xcode including command-line tools and SDL 2.0.

For Windows users, we provide a ready-made build environment based on MinGW-w64.

Visual Studio builds are also possible, but you still need build environment based on MinGW-w64. In order to generate solution and project files just run:

make vs2022

or use this command to build it directly using msbuild

make vs2022 MSBUILD=1

Coding standard

MAME source code should be viewed and edited with your editor set to use four spaces per tab. Tabs are used for initial indentation of lines, with one tab used per indentation level. Spaces are used for other alignment within a line.

Some parts of the code follow Allman style; some parts of the code follow K&R style -- mostly depending on who wrote the original version. Above all else, be consistent with what you modify, and keep whitespace changes to a minimum when modifying existing source. For new code, the majority tends to prefer Allman style, so if you don't care much, use that.

All contributors need to either add a standard header for license info (on new files) or inform us of their wishes regarding which of the following licenses they would like their code to be made available under: the BSD-3-Clause license, the LGPL-2.1, or the GPL-2.0.

See more specific C++ Coding Guidelines on our documentation web site.

License

The MAME project as a whole is made available under the terms of the GNU General Public License, version 2 or later (GPL-2.0+), since it contains code made available under multiple GPL-compatible licenses. A great majority of the source files (over 90% including core files) are made available under the terms of the 3-clause BSD License, and we would encourage new contributors to make their contributions available under the terms of this license.

Please note that MAME is a registered trademark of Gregory Ember, and permission is required to use the "MAME" name, logo, or wordmark.

Copyright (c) 1997-2025  MAMEdev and contributors

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2, as provided in
docs/legal/GPL-2.0.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
more details.

Please see COPYING for more details.