mame README

The project's README from github.com/mamedev/mame. As one markdown file: README.md.

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-2026  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.

mame (mamedev/mame)

Searching Database…

10.6K ·GitHub
这是什么?MAME 是一个多用途模拟框架,其目的是通过记录老式街机硬件、电脑、游戏主机和计算器,来保存数十年的软件历史;模拟器本身则用于验证这些记录的准确性。
它只是一个街机模拟器,还是涵盖了更多内容?它最初是一个街机模拟器(Multiple Arcade Machine Emulator),后来并入了 MESS 项目,因此现在也记录了大量老式电脑、电子游戏主机和计算器。
我怎么自己编译 MAME?在类 UNIX 系统(Linux 和 macOS)上,你可以运行构建命令,进行完整构建,或只构建支持系统中的一小部分。在 Windows 上,项目提供了现成的 MinGW-w64 构建环境,也可以生成 Visual Studio 项目文件,再用 msbuild 进行构建。
编译前需要先安装什么?在 macOS 上,你需要安装带有命令行工具的 Xcode,以及 SDL 2.0;在 Windows 上,即使你打算使用 Visual Studio,也需要提供的基于 MinGW-w64 的构建环境。
我能直接把我的分支或项目叫做 'MAME' 吗?不能。MAME 是注册商标,即使代码本身是自由软件,使用 MAME 名称、标志或文字商标也需要获得许可。
为什么 MAME 的准确性如此重要?由于源代码本身被视为真实硬件的说明文档,模拟器能够正确运行原版软件,就被视为硬件行为已被逆向工程并忠实还原的证明。
Creator
mamedev
Size
1.9 GB
Stars
10.6K
Age
12y
Commits · 90 Days