Commit Graph

366 Commits

Author SHA1 Message Date
AJR
36f6157bc4 luareference.rst: Move the luareference-input properties together 2020-12-26 13:59:37 -05:00
AJR
c04e2cbe0b natkeyboard: Remove from ioport_manager 2020-12-26 13:39:34 -05:00
Vas Crabb
a5e6f4ea8d Expose a couple more things to Lua so the plugins can show the actual key mapped to UI clear. 2020-12-27 04:27:42 +11:00
Vas Crabb
4623e2ecf2 docs: Fix up the instantiation sections in the Lua reference. 2020-12-27 01:46:17 +11:00
Vas Crabb
9e36b6a6d9 More Lua interface cleanup - it's simpler with cleaner underlyng APIs.
Made the sound manager mute controls readable, and got rid of system
enable since it just controls system mute anyway.  This was causing
confusion: phantom2 was trying to use both independentlyt casuing the
mute bit to be ignored.

THe Lua interface changes are mostly changing methods to properties,
some renames to make things clearer, and some additional properties for
better control over snapshots.
2020-12-27 01:32:37 +11:00
AJR
174630bc70 docs: Fix mistake on which key was SDL-specific and which was non-SDL 2020-12-24 13:41:38 -05:00
AJR
c4622a64ab docs: Update list of default keys due to recent removals 2020-12-24 13:35:55 -05:00
Vas Crabb
ed872d1bd2 Fix some oversights and emergent behaviour with view selection.
Exposed the "native snapview" option on the video manager.  Trying to
use presence of a single view is a poor proxy that breaks with
multi-screen systems.

Allow rotation to be changed for native snapshot views, and disable the
zoom to screen area control when it has no effect on the selected view.

Treat an empty string identically to "auto" for view selectction.
Previously this was being used for prefix matching so it would force the
first view.  (This caused the bad snapshot view selection.  It had been
relying on "internal" not being a common view name prefix so it fell
through to automatic selection, but when changed to an empty string it
forced the first view.)

Documented "auto" as well as "native" for the -snapview option and
changed the default to auto rather than an empty string for consistency
with the -viewN options.

Added [w]string_view handlers to the stuff that's instantiated in
strformat.cpp since we'll be increasingly using them.

Cleaned up and updated some documentation.
2020-12-20 15:28:27 +11:00
Vas Crabb
1df245cb99 More Lua engine clean-up and documentation, resulting in core cleanup.
More Lua interface cleanup, additional properties and methods, and
documentation migration/expansion.

Emulated switch inputs can have "not" codes applied to host input axis
directions.  It works the same way as host switch inputs - push twice
for a "not" prefix.

Input polling helpers no longer need to store state in the input device
items.  There’s less leakage, and less chance of things interfering with
each other.

Allow snapshot view options to be configured through the internal UI via
the video options menu.  Made video options menus place initial focus on
the currently selected view item.  Removed some crud from the menu base
class.

Fixed the description of the "snapview" option.  The value to get raw
screen pixels was changed to "native" a long time ago but the
description was never updated.

Re-arranged the Golden Poker button lamps so that the 6-button layouts
for Jolli Witch and Wild Witch make sense.  In 6-button mode, the hold
buttons double as bonus game and bet buttons, but the lamp outputs don't
change.  The simplest way to deal with this without requiring the user
to switch views or using layout scripting is to place the dedicated
buttons directly below the hold buttons that correspond to them.

Removed some software list data that was redundantly copied into
device_image_interface (m_supported was never even set, so it didn't
even work), and made crc() work better (previously it wasn't
recalculuated after unloading and loading another image).

Made strformat.h and devcb.h play nicer with C++17 and pre-standard
C++20.  Format precision now correctly limits the length of string
views.  Confirmed that strformat.{h,cpp} works with pre-standard C++20
support in GCC 9.

Removed an auto_alloc from cpu/arm7.
2020-12-18 15:54:52 +11:00
Vas Crabb
503332a986 -Lua cleanup and documentation migration checkpoint.
* Cleaned up some more of the Lua inteface.  Mostly replacing methods
  with properties, some consistency fixes, a few renames, some more
  exposed functionality, and a couple of properties that have no
  business being set from scripts made read-only.
* Moved a lot more Lua documentation out of source comments into the
  documentation, and expanded on it in the process.
* Got more UI code out of the input manager.
* Changed input sequence poller to a polymorphic class where you
  specify your intention upfront.
* Changed the cheat plugin to use UI Clear to clear hotkey assignments
  and leave them unchanged if the user starts assignment but doesn't
  press any switches.
* Ported AJR's fix for over-eager double-click recognition from SDL to
  Windows OSD.

-goldnpkr.cpp: Cleaned up inputs, using standard keyout and payout types
 and key assignments.
2020-12-16 02:18:52 +11:00
Vas Crabb
4d7ef27490 -luaengine.cpp: Clean up render classes and expose screen image adjustments.
* Started moving Lua class reference to docs.  Expecting people to find
  the class reference material in the source isn’t going to help make it
  approachable.  The docs allow longer explanations, better formatting,
  and cross reference links.

* Added another layout scripting example to the docs.

-goldnpkr.cpp: Minor clean-up.

* Improved the short names for Witch Card and Witch Game clone sets.

* Made Witch Up & Down artwork clickable.

* Added working Video Klein sets where the parent is a working Video
  Klein set to the tiny subtarget.

* Removed history from the header comment - we have version control for
  a readon.
2020-12-13 09:54:03 +11:00
Vas Crabb
6082c57817 docs: Fix a bunch of errors from not reading what I wrote (thanks Ryan). 2020-12-09 01:37:53 +11:00
Vas Crabb
e008c7b1b1 -Lua engine cleanup, input edition:
* Modernised and cleaned up Lua bindings for input classes.
* Exposed the input_sequence_poller class to Lua and updated the
  autofire and cheat plugins to use it, rather than continuing to
  pretend it's part of the input manager.
* Exposed more of the natural keyboard manager, including the ability
  to enable/disable individual keyboard and keypad devices like you
  can from the keyboard mode menu.
* Exposed a few more things on ioport_port and input_device.

-plugins/cheat: Fixed menu item not updating visually when disabling a
 cheat with UI Left.

-plugins/cheatfind: Fixed not finding the first screen after screen
 enumerator was exposed as an object rather than using a table.

-bwidow.cpp, pacman.cpp: Minor cleanup to recent changes.
2020-12-09 01:10:26 +11:00
Vas Crabb
e8998a9236 -luaengine_render.cpp: Work around MSVC ambiguous overload error.
-docs: Clean up a little.
 * Includes typo fixes from Alexander Miller.
2020-11-26 13:47:02 +11:00
Vas Crabb
58c8cba9b3 Work around GNU libstdc++ wanting to stack large temporaries when vector elements can be trivially constructed. 2020-11-23 10:29:23 +11:00
Olivier Galibert
574daf4e49 Implement views, which are essentially bankdevs integrated into the
memory map system. [O. Galibert]
2020-11-22 19:43:52 +01:00
Vas Crabb
55b8ca317a -Switch to building MAME as C++17.
* Updated sol2 to 3.2.2
* Updated pugixml to 1.10
* Increased minimum clang version to 6
* Cleaned up some stuff that can use new features
2020-11-15 03:53:47 +11:00
Vas Crabb
fe9ac15ca9 -emu/devfind: More cleanup/consistency changes.
* Removed .mask(), as it’s not reliable in the general case.
 * Added asserts to things that assume power-of-two sizes.
 * Got rid of virtual qualifier on pointer-to-member operator.
 * Made helpers a bit more assertive about logging warnings.

-emu/rendlay.cpp: Use delegates to avoid hot conditional branches.

-docs: Finished off description of object finders and output finders.
2020-11-13 15:26:31 +11:00
Vas Crabb
39a42d517d Got rid of a couple of easy auto_alloc_array 2020-11-09 05:09:18 +11:00
Vas Crabb
538221861b -emu/dirom.{h,ipp}: Cleaned up and made it stricter.
* Made it an error to specify address map and explicit ROM region.
 * Made it an error if explicitly specified ROM region is not found.
 * Made the ROM region tag apply relative to the current device.

-Cleaned up formatting for a couple more documentation pages.
2020-11-09 03:55:50 +11:00
Vas Crabb
8dc10e7e10 docs: Wrote another section of object finder documentation.
Also improved formatting of code snippets in a few pages.
2020-11-09 00:57:21 +11:00
Vas Crabb
7dcf0c013f emu/devfind.h: Added missing memory_share_array_creator.
Also some miscellaneous tidying up.
2020-11-08 05:43:57 +11:00
Vas Crabb
ae8c70b7e6 -emu/devfind.h: Made read_safe avaiable for optional I/O ports only.
-docs: Added the next couple of sections explaining object finders.
2020-11-06 03:00:57 +11:00
Vas Crabb
6b3b77a50f -docs: Started writing page on object finders with worked examples.
-hp3478a.cpp: Removed outdated TODO comment from layout.

-Hopefully fixed all remaining MSVC operator resolution failure errors.
2020-11-05 00:53:04 +11:00
Vas Crabb
8597660681 -hp3478a.cpp: Made LCD segments dark in internal artwork.
-Fixed another batch of MSVC errors resolving overloaded operators.
2020-11-04 19:51:16 +11:00
Vas Crabb
9e71712b3b -General maintenance on emu/devfind:
* Harmonised memory region/share finder/creator APIs.
 * Moved .found() to optional object finders.
 * Added truth test operator to optional object finders.
 * Fixed things that were testing .found() on required object finders.
 * Improved Doxygen API documentation.

-dec8.cpp: Moved csilver to its own state class.

-docs: Added some notes about setting up and using MSYS2.
2020-11-04 03:12:38 +11:00
Vas Crabb
349265533d Clean-up and consistency fixes after memory system changes. 2020-11-03 02:59:49 +11:00
Olivier Galibert
b8c338858a emumem: Simplify memory management. [O. Galibert]
API impact:
- install_ram/rom/writeonly now requires a non-null pointer.  If you want
  automatically managed ram, add it to a memory map, not in machine_start

- install_*_bank now requires a memory_bank *, not a string

- one can create memory banks outside of memory maps with memory_bank_creator

- one can create memory shares outside of memory maps with memory_share_creator

Memory maps impact:
- ram ranges with overlapping addresses are not shared anymore.  Use .share()
- ram ranges touching each other are not merged anymore.  Stay in your range

Extra note:
- there is no need to create a bank just to dynamically map some memory/rom.
  Just use install_rom/ram/writeonly
2020-11-02 12:12:11 +01:00
Vas Crabb
9ea6512671 docs: Add links to some internal layouts that demonstrate various features, and udpate required MSYS64 packages for using lld. 2020-10-28 14:58:52 +11:00
Vas Crabb
e90403a499 emu/rendlay.cpp: Fixed one more place where disk drawing had error accumulation issues. 2020-10-19 18:13:26 +11:00
Vas Crabb
17c1ef8661 docs: Cleaned up some geometry on MAME logo. 2020-10-09 20:41:57 +11:00
Vas Crabb
ac04c377a9 Optimise some SVG images 2020-10-09 15:52:07 +11:00
Vas Crabb
b90fd35515 Various improvements to image file handling:
Moved MS DIB parser out of ICO file reader and made it available for
artwork and layout images.

Added more efficient I/O and better error checking for JPEG file loading
(MAME will no longer exit immediately on a bad JPEG file).

Made caller responsible for opening files for loading images, to avoid
decompressing images used in ZIP/7z artwork multiple times.

Added support for JPEG and Windows DIB to picture_image_device.

Added support for SVG image files in external artwork.

Added support for using I/O port value for animation state and masking
animation state values.

Made bounds elements more flexible in layouts.

Reworked headers to reduce dependencies.

Updated layout file format documentation.
2020-10-08 02:04:31 +11:00
Vas Crabb
688db69e4c -emu/rendlay.cpp: Small optimisation for opaque pixels in image component.
-machine/pc1512kb.cpp: Put \| and #~ on the right keys by default.

-docs: Re-organised default keys, added P2-4 defaults, added mahjong panel diagram.
2020-09-19 21:07:14 +10:00
Firehawke
02ff9859ed
Merge pull request #7251 from Firehawke/master
Docs adjustments.
2020-09-17 19:09:31 -07:00
Firehawke
d6a71a9db9
Remove VRR statement until it can be retested. 2020-09-17 19:06:43 -07:00
Vas Crabb
0c05da59fd Fix artwork labeld for tisub buttons 2020-09-16 16:47:29 +10:00
Vas Crabb
b1f32927f3 Cleaned up inputs a little.
Removed the IPT_POKER_BET, replacing it with IPT_GAMBLE_BET.

Re-organised the order of input types in the source and the
documentation to better reflect how they're logically grouped or
organised on a mahjong or gambling control panel.

Made the blackjack, poker and slots documentation headings subheadings
under the gambling heading.

Cleaned up inputs for a number of gambling games.
2020-09-16 16:37:22 +10:00
Firehawke
25397ebfda
Docs: Overhaul the default keys list (#7222)
* Docs: Overhaul the default keys list

* Second phase of documenting default inputs better, also change Score to Take Score in Mahjong inputs

* Phase two of default keys docs adjustment.
2020-09-16 11:12:02 +10:00
Vas Crabb
6adc508015 emu/rendlay.cpp: Added parameter animation and state masks.
Components may have multiple bounds and/or color child elements with
state attributes, allowing for piecewise linear position/size/colour
animation.

Components may have a statemask attribute, allowing for things like
using external images to draw a multi-segment LED/VFD display without
requiring dozens of outputs for the individual lines or thousands of
images for all possible states.  (Texture caching still never releases
anything, so MAME can still exceed the maximum number of textures, but
that’s a separate issue.)

Image components with alpha now blend over previously drawn components.

Layouts have been changed to use yes/no for inputraw to match what's
used for flipx/flipy.  External layouts with 1/0 will still work, but
complay.py will complain.
2020-09-16 02:55:04 +10:00
Vas Crabb
7f0a34d52d Updated most of the layouts using <bezel> elements 2020-09-09 20:17:45 +10:00
Vas Crabb
67ec5e5b43 Finished adding new mechanism for allowing parts of views to be hidden.
Changed name of element to "collection" and initial visibility attribute
to "visible", and added them to documentation.  Also added them to
complay.py.

Fixed issue with collection inside group, and improved initial view
selection behaviour.

Updated some internal layouts to demonstrate new features, including
et3400, irrmaze, ltcasino, mekd3/mekd4, seawolf and vgmplay.

Removed all uses of cpanel, marquee and overlay from internal layouts
and removed them from complay.py to actively discourage use.  Also
cleaned up view names in layouts that were using them in place of
spaces, and removed some superfluous name attributes on elements that
won't do anything useful with an output value anyway.

Made vgmplay cycle visualiser modes when visualiser screen is clicked.

Fixed a copy/paste error in bus/rs232/hlemouse.cpp while I'm at it.
2020-09-07 01:40:41 +10:00
Vas Crabb
ec88949651 formats: Get rid of more inappropriate use of emu_fatalerror (and fix some spelling issues, etc. while I'm at it) 2020-08-30 17:08:25 +10:00
Vas Crabb
3b5f754717 docs: Add naming conventions for certain things.
This isn’t supposed to be too prescriptive.  The C++ stuff just codifies
some things we’ve managed to mostly agree on for public interfaces.  The
stuff for titles/descriptions is also just codifying existing rules so
there’s something to point people towards.  This will need to be refined
as we go forward.
2020-08-24 13:01:37 +10:00
Vas Crabb
ecab55f700 emu/video: check macros are defined before doing comparisons, also fix a typo in docs 2020-08-21 23:21:05 +10:00
Vas Crabb
6a1e1bff1a docs: update for changes in MSYS2 packages, fix a typo, add note about using LLVM linker with GCC 2020-08-21 22:43:47 +10:00
Firehawke
41f49b9afe
Fixed compilation of docs for HTML and manfiles. 2020-08-10 19:23:46 -07:00
Aaron Giles
01d5d49518 Documentation update for vector options. 2020-08-05 16:41:08 -07:00
Firehawke
584c471ff3
Documentation updates (#6825)
Documentation updates [Firehawke]
* Preliminary work on -joystick_map redesign
* Adjustments to phrasing for analog mapping
* Health warning text
2020-07-18 08:15:13 -04:00
Firehawke
7b6dbd7a14
First completed pass of commandline parameters. (nw) (#6711)
* First completed pass of commandline parameters. (nw)

* Further refinements on commandline (nw)

* Get the audio latency numbers right and add PortAudio info.

* FreeSync/GSync information cleanup.

* Minor additions to G-Sync/FreeSync.

* Add tip for keyboardprovider, remove biospath, correct anchor positioning (nw)

* A few corrections per Vas (nw)
2020-06-12 14:26:28 +10:00
Olivier Galibert
22513fb6fe emumem: A little more speedup. cache and specific change syntax, and are not pointers anymore [O. Galibert]
The last(?) two changes are:

- Add a template parameter to everything (theoretically the address
  space width, in practice a level derived from it to keep as much
  compatibility between widths as possible) so that the shift size
  becomes a constant.

- Change the syntax of declaring and initializing the caches and
  specifics so that they're embedded in the owner device.  Solves
  lifetime issues and also removes one indirection (looking up the base
  dispatch pointer through the cache/specific pointer).
2020-05-25 16:42:57 +02:00
Firehawke
121aa2fe37
Fix smartquotes by disabling them: While smartquotes are somewhat configurable, it's better if we don't use them at all. Makes sure there are no hidden pit traps for the users. (#6576) 2020-04-21 09:30:06 +02:00
R. Belmont
8cc243d562
Add a tip on how to enter the debugger. 2020-02-06 22:07:49 -05:00
Angelo Salese
a41616e6f7
dialong -> dialog (nw) 2020-01-30 15:58:51 +01:00
Stiletto
88909dc0d0
Happy New Year 2020 (nw) (#6128)
Happy New Year 2020 (nw) (#6128)
2020-01-04 01:13:50 -05:00
Firehawke
a10af356cc Update documentation (nw)
* Update MAME docs revision to 0.216
* Add FAQ question about autofire with walkthrough of setup process.
* Add VSCode .gitignore for RST compilation temporary folder (/docs/source/_build)
* Add a caveat about autofire+normal fire mapping
* Add -lowlatency to the docs.
2019-11-25 18:51:44 +11:00
algestam
d6bddeed59 doc: document vulkan and d3d12 as possible bgfx rendering backends (nw) 2019-11-06 20:17:13 +11:00
Vas Crabb
ecde621979 (nw) fix MPU4 video crash, clean up a little 2019-10-27 15:31:50 +11:00
Vas Crabb
f81fbdb8d4 Make devdelegate more like devcb for configuration. This is a
fundamental change to show device delegates are configured.

Device delegates are now aware of the current device during
configuration and will resolve string tags relative to it.  This means
that device delegates need a device to be supplied on construction so
they can find the machine configuration object.  There's a
one-dimensional array helper to make it easier to construct arrays of
device delegates with the same owner.  (I didn't make an n-dimensional
one because I didn't hit a use case, but it would be a simple addition.)

There's no more bind_relative_to member - just call resolve() like you
would for a devcb.  There's also no need to cast nullptr when creating a
late bind device delegate.  The flip side is that for an overloaded or
non-capturing lambda you'll need to cast to the desired type.

There is one less conditional branch in the hot path for calls for
delegates bound to a function pointer of member function pointer.  This
comes at the cost of one additional unconditional branch in the hot
path for calls to delegates bound to functoids (lambdas, functions that
don't take an object reference, other callable objects).  This applies
to all delegates, not just device delegates.

Address spaces will now print an error message if a late bind error is
encountered while installing a handler.  This will give the range and
address range, hopefully making it easier to guess which memory map is
faulty.

For the simple case of allowing a device_delegate member to be
configured, use a member like this:

    template <typename... T> void set_foo(T &&...args) { m_foo_cb.set(std::forward<T>(args)...); }

For a case where different delegates need to be used depending on the
function signature, see src/emu/screen.h (the screen update function
setters).

Device delegates now take a target specification and function pointer.
The target may be:
* Target omitted, implying the current device being configured.  This
  can only be used during configuration.  It will work as long as the
  current device is not removed/replaced.
* A tag string relative to the current device being configured.  This
  can only be used during configuration.  It will not be callable until
  .resolve() is called.  It will work as long as the current device is
  not removed/replaced.
* A device finder (required_device/optional_device).  The delegate will
  late bind to the current target of the device finder.  It will not
  be callable until .resolve() is called.  It will work properly if the
  target device is replaced, as long as the device finder's base object
  isn't removed/replaced.
* A reference to an object.  It will be callable immediately.  It will
  work as long as the target object is not removed/replaced.

The target types and restrictions are pretty similar to what you already
have on object finders and devcb, so it shouldn't cause any surprises.
Note that dereferencing a device finder will changes the effect.  To
illustrate this:

    ...
    required_device<some_device> m_dev;
    ...
    m_dev(*this, "dev")
    ...
    // will late bind to "dev" relative to *this
    // will work if "dev" hasn't been created yet or is replaced later
    // won't work if *this is removed/replaced
    // won't be callable until resolve() is called
    cb1.set(m_dev, FUNC(some_device::w));
    ...
    // will bind to current target of m_dev
    // will not work if m_dev is not resolved
    // will not work if "dev" is replaced later
    // will be callable immediately
    cb2.set(*m_dev, FUNC(some_device::w));
    ...

The order of the target and name has been reversed for functoids
(lambdas and other callable objects).  This allows the NAME macro to
be used on lambdas and functoids.  For example:

    foo.set_something(NAME([this] (u8 data) { m_something = data; }));

I realise the diagnostic messages get ugly if you use NAME on a large
lambda.  You can still give a literal name, you just have to place it
after the lambda rather than before.  This is uglier, but it's
intentional.  I'm trying to drive developers away from a certain style.
While it's nice that you can put half the driver code in the memory map,
it detracts from readability.  It's hard to visualise the memory range
mappings if the memory map functions are punctuated by large lambdas.
There's also slightly higher overhead for calling a delegate bound to a
functoid.

If the code is prettier for trivial lambdas but uglier for non-trivial
lambdas in address maps, it will hopefully steer people away from
putting non-trivial lambdas in memory maps.

There were some devices that were converted from using plain delegates
without adding bind_relative_to calls.  I fixed some of them (e.g.
LaserDisc) but I probably missed some.  These will likely crash on
unresolved delegate calls.

There are some devices that reset delegates at configuration complete or
start time, preventing them from being set up during configuration (e.g.
src/devices/video/ppu2c0x.cpp and src/devices/machine/68307.cpp).  This
goes against the design principles of how device delegates should be
used, but I didn't change them because I don't trust myself to find all
the places they're used.

I've definitely broken some stuff with this (I know about asterix), so
report issues and bear with me until I get it all fixed.
2019-10-26 12:47:04 +11:00
Firehawke
54b3968c74 New working software list additions (#5772)
* New working software list additions
-----------------------------------

apple2_flop_orig: Gauntlet, Go (Hayden), Ghostbusters, Galactic Wars, Guderian [4am, Firehawke]

* Add details on compiling MAME documentation. (nw)
2019-10-23 10:21:26 -04:00
Vas Crabb
2032eb60a6 Allow per-layer blend modes supplied by driver for screens, as required
for Laserdisc overlays.

This is a change in behaviour, and it means that games like Golly!
Ghost! will need an explicit blend mode specified in the XML.  I'm not
entirely happy with the situation, but a better, more general solution
than this would require some serious refactoring to MAME's renderer.
2019-07-27 23:24:37 +10:00
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
Firehawke
50d72f5e71 Overhaul to advanced gun instructions (nw)
This cleans up spelling and other issues in the original text.

This work is still prototype and will probably require fine-tuning between Vas and myself.
2019-05-28 22:24:26 -07:00
Vas Crabb
9037a85e32 (nw) Fedora users need this now that X11 XInput is enabled by default - no clue about other Linuxes 2019-04-26 01:55:17 +10:00
R. Belmont
efdaa09d54
Merge pull request #4914 from kiall/docs-linux-lightguns
WIP: Document Linux Lightguns with Xinput
2019-04-25 09:41:30 -04:00
Henrik Algestam
731c3f9dc0 doc: add python to list of required ubuntu packages (nw) 2019-04-23 17:12:00 +02:00
Kiall Mac Innes
526e2cb3b1 Document Linux Lightguns with Xinput
Add a new doc page within the 'Advanced Configuration' section which
describes how to enable Lighuns on Linux using the XInput lightgun
provider.
2019-04-21 12:57:51 -07:00
Vas Crabb
97b6717027 (nw) Clean up the mess on master
This effectively reverts b380514764 and
c24473ddff, restoring the state at
598cd52272.

Before pushing, please check that what you're about to push is sane.
Check your local commit log and ensure there isn't anything out-of-place
before pushing to mainline.  When things like this happen, it wastes
everyone's time.  I really don't need this in a week when real work™ is
busting my balls and I'm behind where I want to be with preparing for
MAME release.
2019-03-26 11:13:37 +11:00
andreasnaive
b380514764 Revert "conflict resolution (nw)"
This reverts commit c24473ddff, reversing
changes made to 009cba4fb8.
2019-03-25 23:13:40 +01:00
hap
2b53b22bb5 layout doc: reword (nw) 2019-03-25 13:04:27 +01:00
hap
cdde287597 layout doc: correction and add inputraw (this one actually does work the way inputmask was documented before) (nw) 2019-03-24 23:30:02 +01:00
AJR
b84397f786 Make -nonvram_save also inhibit saving of "battery" NVRAM for image devices 2019-02-19 20:47:39 -05:00
Vas Crabb
34ebe564b0 (nw) omission, formatting 2019-02-18 21:55:45 +11:00
Vas Crabb
8ffff5d2d3 (nw) misc stuff:
* Document cross-compilation options
* Use lowercase for some libraries that are lowercase in system32 on Windows anyway
* Make USE_BUNDLED_LIB_SDL2=0 not use the bundled SDL
2019-02-18 21:13:44 +11:00
cam900
e65f6d75e1 device_memory_interface.rst : Correct docs 2019-02-18 00:34:05 +11:00
Olivier Galibert
7e53d69069 Add svg->pdf conversion support 2019-01-28 11:09:20 +01:00
Vas Crabb
9ce054c04b slight logo update (nw) 2019-01-28 17:50:38 +11:00
Firehawke
437b7a1c90 Initial implementation of new logo for docs (nw) (#4566)
* Initial implementation of new logo for docs (nw)

Behold the power of SVG!

* 100% gives the same results (nw)
2019-01-28 17:43:37 +11:00
Vas Crabb
995ba92e83 update docs (nw) 2019-01-28 03:59:45 +11:00
algestam
2619be3e18 Doc: Minor fix (nw) (#4547) 2019-01-22 19:09:26 +01:00
Firehawke
ff8cda02cb Correct compilation packages (for #4507) and finish cleanup on previous docs updates. (nw) (#4509)
* Correct the compilation packages [partial for #4507] (nw)

* Minor corrections, joymap adjustments (nw)
2019-01-13 11:18:09 -05:00
Vas Crabb
64c1f2eb5b make INI file loading examples match current behaviour at least (nw) 2019-01-12 05:37:24 +11:00
Vas Crabb
4a6f5ee78f better documentation for compiling on Windows (nw) 2019-01-12 02:23:28 +11:00
Stiletto
a5461d9d6b
2018 -> 2019 changes (nw)
* 2018 -> 2019 changes (nw)
2019-01-10 17:01:26 -05:00
Vas Crabb
4c444b2a00 more command line doc cleanup (nw) 2019-01-11 01:37:17 +11:00
Firehawke
9e3e966dea Major formatting update for command line options, copyright/version update (#4470)
* Update copyrights and docs revision (nw)

Updates copyright on existing 2018 entries to 2019 (and one 2016)
Updates the docs compilation script to MAME 0.205 and 2019 copyright.

* Further formatting overhauling (nw)

Clamp to 80 column where possible; it makes it easier to track errant
line breaks, etc.
Also begin standardizing tab formatting and two spaces after period.

* Further corrections to command line materials (nw)

* More adjustments for Cuavas (nw)

Getting closer to acceptable.
2019-01-11 01:06:52 +11:00
Vas Crabb
cba80b7182 Make informational verbs a bit more consistent, reduce copy/pasted code, a slight performance improvement for reading localisation files, and more documentation clean-up/correction/clarification 2019-01-04 01:12:02 +11:00
Firehawke
6432d66037 Case sensitivity training for INI (nw) (#4455)
* Case sensitivity training for INI (nw)

The world is not 100% Windows, so case sensitvity is needed.

* Further standardization of the formatting (nw)

More to go...

* Pass 2 of new formatting wave (nw)

More to go, though.

* wave 3 of formatting cleanup (nw)

Further adjustments and cleanups, including unwanted tabs.

* Correct filtering instructions (nw)
2019-01-03 04:05:21 +11:00
Vas Crabb
8d40db558e additional documentation on compiling MAME (nw) 2019-01-01 23:30:41 +11:00
Vas Crabb
0374e6f542 (nw) update some documentation and get the MAME and legacy MESS pages more in sync. sorry if I've busted formatting, I can't currently build sphinx or man on this Windows notebook. 2018-12-25 02:57:15 +11:00
Vas Crabb
82501770de srcclean and cleanup (nw) 2018-10-28 14:00:12 +11:00
Firehawke
a2e218f853 Clean up phrasing a bit on input from MG (nw) 2018-10-19 17:02:01 -07:00
Firehawke
ae97f80cb3 Update FAQ (nw) with HLSL/BGFX update info, old external OPL2 support information 2018-10-19 16:47:47 -07:00
Wellington Uemura
62bf710d9d
Fixed broken document structure
* Those chapter numbers are auto generated by sphinx
* Fix the chapters not been bold like the rest of the documentation
* Fix chapter numbers not in sync with the rest of the documentation
* Change the last two chapters to keep up with the document consistency
* Fix bold for nscsi_full_device
2018-10-04 15:42:44 -03:00
Scott Stone
9c0c084d18 Misc. document fixes (nw) 2018-09-26 03:34:20 -04:00
Scott Stone
4861195216 Some more documentation structure fixes (nw) 2018-09-24 15:32:17 -04:00
Scott Stone
91b9f92ddc Misc documentation fixes as brought up by other developers (nw) 2018-09-24 15:20:49 -04:00
Scott Stone
3e94624a08 reference fix (nw) 2018-09-24 14:03:31 -04:00
Scott Stone
fdb070c61d Started commandline documents update to dismiss items no longer in source and start listing recently added commands. More work to come. [Tafoid] 2018-09-24 13:55:18 -04:00
Wellington Uemura
1ab4cac22c
Add missing short commands
I've noticed this while I was translating the manual.
2018-09-13 20:33:40 -03:00
Firehawke
43aa0dbc75 Reword the entire merged set example to avoid long sentence soup (#3857)
* Reword the entire merged set example to avoid long sentence soup, also clarify parent/clone (nw)

* Per request, adjust phrasing slightly more. (nw)
2018-08-17 14:43:01 +10:00
ajrhacker
6d20c2322e
Merge pull request #3843 from felipesanches/wuemura_typo_fix_3805
Fix a typo (found by Wellington Uemura, @katananja) and...
2018-08-09 23:13:26 -04:00
Wellington Uemura
1b47072e49 Fix a typo (found by Wellington Uemura, @katananja) and...
... also replace the '--' by a Harvard comma, as suggested by @cuavas.
(see also: pull request #3805)
2018-08-09 18:49:06 -03:00
Vas Crabb
e0df7a929f finish off layout documentation for now 2018-08-03 16:54:36 +10:00
Vas Crabb
6ea9ff9042 (nw) Further layout work:
* Allow <orientation> and <color> to work on group references
* Fix some corner cases where group bounds could be miscalculated
* Fix a corner case where MAME could incorrectly refuse to instantiate groups
* Add more checks to complay.py
* Document more of the layout format
2018-08-02 23:11:17 +10:00
Vas Crabb
4c0c840f96 (nw) be less eager to shadow variables in layouts, make highlights visible on white squares in modena 2018-07-31 23:54:12 +10:00
Vas Crabb
781d943b36 (nw) more layout documentation 2018-07-31 21:40:20 +10:00
Vas Crabb
0ce07a8a1e (nw) more render work:
* Clean up some corner cases in layouts with repeating blocks
* Make complay.py validate many more elements and attributes
* Make complay.py easier to use for just validating a layout
* Remove redundant view from Sega VMU layout
* Make buttons visually respond to input in whousetc.lay
* Add view with LED displays as well as terminal for aim65_40 and use repeats
* Clean up some outdated "game" terminology in clifront.cpp
* Initiaise a couple of members in tap/tun network module
* Start documenting layout format
2018-07-31 04:18:28 +10:00
Vas Crabb
ccfcb431d0 cherry-pick fixes from mainline and clean up some stuff (nw) 2018-07-23 12:29:25 +10:00
Vas Crabb
6669489679 allow repeating elements and groups - useful if you need e.g. a lot of numbered labels, but it limits complay.py's ability to check for invalid references as it can't evaluate expressions (nw) 2018-07-22 09:52:50 +10:00
Justin Kerk
7809e9005d Better Emscripten parameter handling, & update docs (nw) 2018-07-21 22:05:45 +00:00
Erik Dominikus
34be272b36 Document debugger expression number syntax 2018-03-27 02:06:25 +11:00
Nigel Barnes
ab394331ce Spelling fix in castool documentation (nw) 2018-03-06 13:37:56 +00:00
Vas Crabb
7f6f2a03ff note required Emscripten version (nw) 2018-02-25 18:55:53 +11:00
Vas Crabb
bd473383c8 support multiple patterns and devices in -listfull verb 2018-02-24 03:56:15 +11:00
Stiletto
e51076bd41
(nw)
(nw)
2018-02-07 16:40:50 -05:00
Stiletto
ec5d60720f
Minor updates (nw)
Minor updates (nw)
2018-02-07 16:38:41 -05:00
Firehawke
b2e11d00e0 More docs work: escapes, debugger update (nw) (#3168)
* Missed a couple escape sequences. (nw)

* A little more escaping, acronym fixes, fix oddity in symlist (nw)

* Update debugger internal help to match docs (nw)

* Lowercasing for CPU in command parameters, fix casing on ASCII. (nw)
2018-02-05 20:27:02 +11:00
Firehawke
752cf3d073 Missed a couple escape sequences. (nw) 2018-02-03 19:26:25 +11:00
Firehawke
87cc4b5c4b Terminology cleanup second pass (nw) 2018-02-01 16:58:52 +11:00
Firehawke
010d35fa3f Final pass of verbiage cleanup. (nw) 2018-02-01 16:58:52 +11:00
Firehawke
699de02498 A few corrections for wave 2, more to come. (nw) 2018-02-01 16:58:52 +11:00
Firehawke
7322eeccc3 Terminology update wave 1 (nw) 2018-02-01 16:58:52 +11:00
Firehawke
f481e6b23a Overhaul commandline section of docs, includes index with linkable anchors. (#3112)
* The first set of commandline overhauls. (NW)

* Correct case on headings, further improvements to index, spelling fix

* More updates to the index and cleanup to the commandline stuff. [NW]

* More core options in the index. [NW]

* Finished multiplatform commandline index [NW]

* Completion of first revision commandline index [NW]
2018-01-25 08:37:48 +11:00
Stiletto
feecaac20e
update docs version
update docs version
*nw* just taking care of an annoyance. As far as we know, docs are in sync. If not, it's easily fixed.
2018-01-16 13:56:02 -05:00
Firehawke
88c8b5b0c7 Add additional memory operators per request (NW) (#3067)
* Add additional memory operators per request and further cleanups to expressions (NW)

* Requested adjustments to expressions. (NW)
2018-01-15 15:25:23 +11:00
Firehawke
f2859d0db0 Correct command heading case and adjustments to expressions (NW) 2018-01-15 02:11:15 +11:00
Firehawke
18d3d5ac50 First pass of MAME Debugger help for documentation. (NW) 2018-01-13 21:56:18 -07:00
Nigel Barnes
13b75ab76a Updated documentation for castool and added floptool (nw) 2018-01-11 20:52:49 +00:00
Jonathan Holt
c25b98226d Updates "2017" strings to "2018" where relevant. 2018-01-06 00:48:05 +11:00
Firehawke
52667a4b20 Basic anchor links for FAQ page (#2975) 2017-12-27 14:23:37 -05:00
vadosnaprimer
7e7f2fafd0 rewind implementation fixes and improvements
- reset scheduler savestate to what it was for years before rewind
-- changing saved variables should be done after thorough testing. right now, adding some vars breaks some machines, adding other vars breaks others
- switch to megabyte-wise capacity
-- savestate size greatly differs between machines, relying on state count is unstable
- switch to internal indexing
-- no longer depends on inaccurate machine time
- rewind accelerator key in debugger (Ctrl+F11)
- report capacity hit (once), with some useful info
- make error reports saner
- mention rewind and rewind_capacity in the docs
2017-12-22 04:39:14 +03:00
Stiletto
ded50220ad
(nw) more minor typo fixes for docs.mamedev.org 2017-12-14 00:57:18 -05:00
Firehawke
9ece34eb21 Revert "Revert "Merge branch 'master' of https://github.com/mamedev/mame""
This reverts commit 54155441e9.
2017-12-13 21:31:27 -07:00
Firehawke
54155441e9 Revert "Merge branch 'master' of https://github.com/mamedev/mame"
This reverts commit f537428e5a, reversing
changes made to 0d70d79810.
2017-12-13 21:01:10 -07:00
Stiletto
edb558b916
(nw) more self-service 2017-12-13 15:11:37 -05:00
Stiletto
34ab1202e7
Update whatis.rst
(nw) self-service
2017-12-13 14:26:34 -05:00
AJR
412ef97d71 No more UINT (nw) 2017-12-10 15:32:59 -05:00
AJR
e733af5b08 Documentation update (nw) 2017-12-10 15:32:24 -05:00
Olivier Galibert
6caef2579a dvdisasm: Overhaul [O. Galibert]
Disassemblers are now independant classes.  Not only the code is
cleaner, but unidasm has access to all the cpu cores again.  The
interface to the disassembly method has changed from byte buffers to
objects that give a result to read methods.  This also adds support
for lfsr and/or paged PCs.
2017-11-26 17:41:27 +01:00
hap
2069183658 doc: update MAME short description (nw) 2017-11-05 18:12:28 +01:00
hap
adb7ce7b2e put original abbreviation meaning as trivia here (nw) 2017-11-05 02:01:20 +01:00
hap
7d7c2c5507 make emulator description generic (nw) 2017-11-05 01:50:16 +01:00
Vas Crabb
1e8c0b23c3 This is too contentious, please put it up for review
Revert "Changes to debugger memory address translation"

This reverts commit bb0964f9a2.
2017-08-01 15:19:44 +10:00
AJR
bb0964f9a2 Changes to debugger memory address translation
- memory_translate now returns an address space number rather a boolean flag, permitting addresses in part of one space to map to an entirely different space. This is primarily intended to help MCUs which have blocks of internal memory that can be dynamically remapped, but may also allow for more accurate emulation of MMUs that drive multiple external address spaces, since the old limit of four address spaces per MAME device has been lifted.
- memory_translate has also been made a const method, in spite of a couple of badly behaved CPU cores that can't honestly treat it as one.
- The (read|write)_(byte|word|dword|qword|memory|opcode) accessors have been transferred from debugger_cpu to device_memory_interface, with somewhat modified arguments corresponding to the translate function it calls through to if requested.
2017-08-01 00:21:19 -04:00
Michael.S.G
02cfda6957 Include -output option in documentation
Include -output and it's available options in documentation.
2017-07-05 21:38:39 +10:00
Brian King
834da5a8c1 Updated Fedora instructions
DNF is now preferred package manager. alsa-lib-devel is also required (not mentioned in the current docs)
2017-07-04 12:00:51 -05:00
Olivier Galibert
cbbbd07484 dimemory: Lift the cap on the number of address spaces per device [O. Galibert] 2017-07-03 08:03:57 +02:00
Olivier Galibert
cb1930f6e6 Rename AS_DECRYPTED_OPCODES to AS_OPCODES [O. Galibert] 2017-07-03 08:03:57 +02:00
Stiletto
580898e4ca (nw)
(nw)
2017-06-25 10:34:31 -04:00
Dan Amador
3a43ec44cc Update luaengine.rst 2017-05-22 18:08:28 -05:00
Stiletto
4803de2501 (nw)
(nw)
2017-05-10 14:38:31 -04:00
Stiletto
847e0a1d14 update edit docs link (nw)
update edit docs link (nw)
2017-05-10 10:41:29 -04:00
Prayag Verma
eb7b1f3d20 Fix typos
slighly → slightly
transistion → transition
2017-03-24 23:26:03 +05:30
Stiletto
9db7b63e9a Updates "2016" strings to "2017 where relevant.
Updates "2016" strings to "2017 where relevant.
2017-01-24 17:29:49 -05:00
Vas Crabb
66f1cb5f3a srcclean again (nw) 2016-11-30 07:04:04 +11:00
Olivier Galibert
0136468462 dirom: Document the interface evalution [O. Galibert] 2016-11-28 19:16:39 +01:00
ImJezze
e6580c50a2 Corrected HLSL documentation
- removed -antialias option (does not exist anymore)
- added missing -vector_beam_smooth option
- fixed suggested default values for -bloom_lvl_weights options (were messed up in the last update)
2016-11-14 15:59:15 +01:00
Firehawke
ce943bd45b NW - More documentation updates..
* Fix a few 'mess' references.
* Add important note for -listslots
* FAQ: Wouldn't MAME be faster if X?
2016-10-29 23:32:36 -07:00
Tomer Verona
845b36dae2 Adding id() property to input_device
This change adds id() property to input_device, which represents the
unique device id. This allows the osd layer when creating a device to
pass a friendly display name along with a unique identifier.

Currently the device id is only used to map a physical controller device
to controller id, but can be used more generally in the future. For raw
input devices, we use the full raw input name as the device id. For all
other devices, we fall back to device name as the device id. The
"uniqueness" of the device id is not currently enforced in code.
2016-09-20 12:19:58 -07:00
Tomer Verona
32ea8266a3 A couple of fixes
- Fix null-reference exception when mapping device to unused (null)
controller index
- Restrict device map to controller configs
2016-09-20 01:24:36 -07:00
Tomer Verona
0ed1ce5663 Tweak info message 2016-09-14 17:53:34 -07:00
Tomer Verona
2bd18d5fea Support for configuring device to conrtoller id
This change adds support for configuring device to conrtoller id. This
allows for stable controller ids even if USB devices are plugged /
unplugged, system is rebooted, etc.

See documentation for additional context.
2016-09-12 18:35:36 -07:00
Olivier Galibert
a2c306e923 dimemory, dirom: Add some documentation [O. Galibert] 2016-09-06 12:47:20 +02:00
Firehawke
9d93c07c66 First draft on ROM management for newbies, FAQ entry on common problems with unofficial builds 2016-09-05 00:21:23 -07:00
Miodrag Milanovic
cb30b9d307 Added documentation to main tree (nw) 2016-08-24 15:16:43 +02:00