Go to file
Vas Crabb f47f9c3db3
ui, docs: Added menus to fill a couple of gaps, improved consistency. (#9915)
Added menus for controlling toggle inputs, and showing recognised input
devices and control state.  Moved input menu options off main menu to a
submenu, as there are a lot of them now.

Moved menu heading drawing into base class, added headings to more
menus, and made headings more consistent with the menu items used to
reach them.  Also made terminology more consistent.

Changed the default names for buttons and hat switches/D-pads to use
1-based numbering.  DirectInput still returns 0-based button numbers for
some devices.

Removed local copy of MinGW xaudio2.h as it’s now included in the MSYS2
package.  Also fixed building the DirectSound sound output module with
the SDL OSD on Windows - the Windows headers are sensitive to include
order.

Started adding documentation for menus, to hopefully help people find
menus they remember seeing but can't recall how to access.

For translators, this makes terminology more consistent.  In particular:
* "Settings" is preferred over "configuration" in a number of places, as
  the latter can be construed as referring specifically to settings
  stored in .cfg files in the cfg_directory folder.  Also, references to
  saving machine configuration could be interpreted as relating to the
  settings on the "Machine Configuration" menu.
* The controls on host input devices (e.g. keys, buttons, joystick axes)
  are referred to as "controls", while emulated inputs are referred to
  as "inputs".
* The menus for assigning host controls to emulated inputs are called
  "input assignments" menus to distinguish them from other input
  settings menus.
* Combinations of controls that can be assigned to emulated inputs are
  referred to as "combinations" rather than "sequences".
* The potentially confusing term "ROM set" has been removed altogether.
  Use "short name" to refer to a device or system's identifier.
* "System" is used in almost places to refer to a complete, runnable
  system rather than "Machine".
* "Driver" is now only used to refer to source files where systems or
  devices are defined - it is no longer used to refer to individual
  systems.
* A few more menus have message context for the messages.  This makes it
  a bit easier to guess where the messages are used.  It also means you
  can use different translations in different places if necessary (e.g.
  if the same English text should be translated differently as an item
  in one menu and as a heading in another).
2022-06-11 21:47:19 +10:00
.github/workflows -docs: Started documenting plugins. 2021-10-24 05:48:05 +11:00
3rdparty ui, docs: Added menus to fill a couple of gaps, improved consistency. (#9915) 2022-06-11 21:47:19 +10:00
android-project Bump version to 0.244 2022-05-24 14:32:30 +10:00
artwork -bgfx: Added default LUT PNG, fixes LUT-effect crash. Fixed external texture loading, restoring HQx filters. [Ryan Holtz] (#9401) 2022-03-12 20:30:02 -05:00
benchmarks Fix building benchmarks 2021-06-22 14:42:29 +02:00
bgfx -bgfx: Fixed YUV shader to have better brightness balance. [Ryan Holtz] (#9425) 2022-03-17 04:40:38 +11:00
ctrlr Fixed MT07153 (SlikStick configuration for asteroid not working). 2021-12-06 03:13:53 +11:00
docs ui, docs: Added menus to fill a couple of gaps, improved consistency. (#9915) 2022-06-11 21:47:19 +10:00
doxygen debugger: Extended target address syntax to include device/address space. (#8630) 2021-10-01 05:26:11 +10:00
hash ibm5170.xml: 18 new software additions (#9891) 2022-06-08 11:03:40 -04:00
hlsl HLSL Color Transforms and 3D LUT (#4043) 2018-10-07 11:42:30 -04:00
ini HLSL Color Transforms and 3D LUT (#4043) 2018-10-07 11:42:30 -04:00
keymaps (nw) More license shuffling 2020-03-07 22:02:56 +11:00
language ui, docs: Added menus to fill a couple of gaps, improved consistency. (#9915) 2022-06-11 21:47:19 +10:00
plugins ui, docs: Added menus to fill a couple of gaps, improved consistency. (#9915) 2022-06-11 21:47:19 +10:00
projects
regtests Bug fix for when viewing the logic equations of the GAL16V8 device with jedutil (#9315) 2022-02-18 22:38:44 -05:00
roms Restore this, it's used when building packages (nw) 2017-10-25 01:34:02 +11:00
samples
scripts ui, docs: Added menus to fill a couple of gaps, improved consistency. (#9915) 2022-06-11 21:47:19 +10:00
src ui, docs: Added menus to fill a couple of gaps, improved consistency. (#9915) 2022-06-11 21:47:19 +10:00
tests Bumped dates to 2022, bumped docs version to 0.240, fixed some license files that had somehow been screwed up, cleaned up some metadata. 2022-01-29 00:45:52 +11:00
web Bumped dates to 2022, bumped docs version to 0.240, fixed some license files that had somehow been screwed up, cleaned up some metadata. 2022-01-29 00:45:52 +11:00
.editorconfig docs: Add naming conventions for certain things. 2020-08-24 13:01:37 +10:00
.gitattributes
.gitignore spi_sdcard: add CMD18 - CMD_READ_MULTIPLE_BLOCK (#8913) 2021-12-01 18:49:48 -05:00
.travis.yml Create GitHub Actions for CI (#7335) 2020-10-21 22:42:17 +11:00
COPYING ui, docs: Added menus to fill a couple of gaps, improved consistency. (#9915) 2022-06-11 21:47:19 +10:00
dist.mak Added PDF documentation to dist.mak 2022-01-12 05:43:41 +11:00
makefile Adjust toolchain versions for triggering workarounds: 2022-06-06 04:00:02 +10:00
README.md Deleted travis-ci.org badge from README.md. (#8816) 2021-12-04 03:21:00 +11:00
uismall.bdf uismall.bdf: Added 57 glyphs (mostly arrow symbols). 2022-02-01 02:07:50 +11:00

MAME

Join the chat at https://gitter.im/mamedev/mame

Build status:

OS/Compiler Status
Linux/GCC and clang CI (Linux)
Windows/MinGW GCC CI (Windows)
macOS/clang CI (macOS)
UI Translations Compile UI translations
Documentation Build documentation

Static analysis status for entire build (except for third-party parts of project):

Coverity Scan Status

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.

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 MAME build,

make SUBTARGET=arcade

for an arcade-only build, or

make SUBTARGET=mess

for a MESS build.

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 vs2019

or use this command to build it directly using msbuild

make vs2019 MSBUILD=1

Where can I find out more?

Contributing

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.

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