Go to file
Vas Crabb c38a3395e9 Make layout format more flexible:
* There is no longer a concept of "layers" - there are only screens and elements.
* Elements are now instantiated with <element ref="...">
* Screens and elements can have explicit blending mode specified with blend="..."
* Default blending mode for screens is "add" and default for other elements is "alpha"
* Other supported modes are "none" and "multiply"
* This removes the options to enable/disable layers individually - use views instead
* Legacy layouts can still be loaded, and support won't be removed for at least a year

The current artwork model is over-stretched.  It's based on a Space
Invaders cabinet model, and isn't applicable to a lot of the systems
MAME emulates now.  The fact that MAME has to switch to an "alternate"
mode to deal with games like Golly! Ghost! without requiring pre-matted
bitmaps shows that the Space Invaders model wasn't even adequate for
general arcade use.  It shows in that for a lot of the systems that
heavily depend on artwork, people just seem to randomly choose layers
for elements until they get something that works.  Also, the fact that
MAME will switch to an alternate (Golly! Ghost!) mode depending on the
combination of elements is a trap for people learning to make artwork.

There are cases that the current approach of implying the blending mode
from the layer doesn't work with.  Examples include LEDs behind
diffusers (requires additive blending for layout elements), and mutliple
stacked LCD panels (requires RGB multiplication for screens).

For configurability, it's now a lot easier to make multiple views using
groups.  For example, if you want to make it possible to hide the
control panel section of your layout, you can put the control panel
elements in a group and create views with and without it.

I will gradually migrate the internal artwork to use the new approach.
I have an XSLT stylesheet that helps with this, but I'm not comfortable
adding it because it isn't a complete solution and it still requires
manul steps.

I wanted to get the re-worked pointer handling done sooner so I could
push them both at the same time, but unfortunately various things have
prevented me from progressing as quickly as I wanted to.  Sorry guys,
that stuff's going to have to wait.
2019-07-06 00:23:20 +10:00
3rdparty Partial support for encrypted audio in k573dio (Konami System 573 Digital I/O) (#5055) 2019-05-15 20:17:00 -04:00
android-project version bump (nw) 2019-06-26 20:25:30 +10:00
artwork reword (nw) 2019-06-12 17:46:12 +02:00
benchmarks (nw) Clean up the mess on master 2019-03-26 11:13:37 +11:00
bgfx (nw) Clean up the mess on master 2019-03-26 11:13:37 +11:00
ctrlr move some content for release archive out of build repo into main repo 2017-08-14 19:30:35 +10:00
docs Make layout format more flexible: 2019-07-06 00:23:20 +10:00
doxygen doc: update MAME short description (nw) 2017-11-05 18:12:28 +01:00
hash spectrum softlist stuff [see previous credits list] (#5304) 2019-07-04 16:56:18 -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) Clean up the mess on master 2019-03-26 11:13:37 +11:00
language a few translations... 2019-06-26 13:14:53 +03:00
nl_examples netlist: improved and fast LM3900 model. 2019-04-12 00:44:23 +02:00
plugins Change autofire config directory to homepath (#5129) 2019-05-30 14:31:57 -04:00
projects Enable building projects that are separate of MAME but use same core and lives in separate git tree (nw) 2016-12-08 11:46:15 +01:00
regtests (nw) Clean up the mess on master 2019-03-26 11:13:37 +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 Make layout format more flexible: 2019-07-06 00:23:20 +10:00
src Make layout format more flexible: 2019-07-06 00:23:20 +10:00
tests (nw) Clean up the mess on master 2019-03-26 11:13:37 +11:00
web (nw) Clean up the mess on master 2019-03-26 11:13:37 +11:00
.appveyor.yml appveyor: might as well (nw) 2018-12-20 12:57:02 +07:00
.drone.sec
.drone.yml Can tea-ci build tools? 2016-07-08 15:35:57 +10:00
.gitattributes move some content for release archive out of build repo into main repo 2017-08-14 19:30:35 +10:00
.gitignore mega32x.cpp: refactor and convert read/write handlers to 16-bit space [Angelo Salese] 2019-06-22 14:43:16 +02:00
.travis.yml Add libxi-dev to Travis Config 2019-05-29 19:05:07 +01:00
dist.mak Add ini/examples to dist.mak (#4234) 2018-11-02 21:07:16 -04:00
LICENSE.md (nw) Clean up the mess on master 2019-03-26 11:13:37 +11:00
makefile version bump (nw) 2019-06-26 20:25:30 +10:00
README.md (nw) Clean up the mess on master 2019-03-26 11:13:37 +11:00
uismall.bdf (nw) Clean up the mess on master 2019-03-26 11:13:37 +11:00

MAME

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

Build status for tiny build only, containing just core parts of project:

OS/Compiler Status
Linux GCC / OSX Clang Build Status
Windows MinGW Build Status
Windows MSVC Build status

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 *NIX or OSX system, 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 MESS build.

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

For recent versions of OSX 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 vs2017

or use this command to build it directly using msbuild

make vs2017 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 distributed 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 files (over 90% including core files) are under the BSD-3-Clause License and we would encourage new contributors to distribute files under 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-2019  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 as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

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.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Please see LICENSE.md for further details.