Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@amadvance
amadvance committed Feb 11, 2024
1 parent 5b6fb30 commit 821679c
Show file tree
Hide file tree
Showing 4 changed files with 108 additions and 61 deletions.
27 changes: 14 additions & 13 deletions doc/build.d
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ Name{number}
programs from the source archives.

Build
To build the Advance programs you need to have installed the development tools.
To build the Advance programs you need to have installed the
development tools.

What to install depends on your system, but in general you need the GCC compiler,
and the SDL library.
What to install depends on your system, but in general you need the
GCC compiler, and the SDL library.

For Ubuntu run:
:$ sudo apt-get update
Expand All @@ -18,13 +19,13 @@ Build
:$ sudo apt-get update
:$ sudo apt-get install git autoconf automake libsdl2-dev libasound2-dev libfreetype6-dev zlib1g-dev libexpat1-dev libslang2-dev libncurses5-dev

Note that in Raspbian it's highly recommended to run the Advance programs outside
the X/Pixel graphics environment to get the best performance.
For this reason the SDL library "libsdl2-dev" is not required, and you can omit
it if you like.
Note that in Raspbian it's highly recommended to run the Advance
programs outside the X Window graphics environment to get the best
performance. For this reason the SDL library "libsdl2-dev" is not
required, and you can omit it if you like.

At this point you can get the source code from the http://www.advancemame.it site,
and untar it with:
At this point you can get the source code from the http://www.advancemame.it
site, and untar it with:

:$ tar xf advancemame-*.tar.gz
:$ cd advancemame-*
Expand All @@ -43,11 +44,11 @@ Build

The -j3 option uses three parallel processes, speeding up the build.

The build process may be long, up to 45 minutes on a Raspberry Pi 3, or 25 on
Raspberry Pi 4.
The build process may be long, up to 45 minutes on a Raspberry Pi 3,
or 25 on Raspberry Pi 4.

No option is generally required. You can get the complete configure option list with
the `./configure --help' command.
No option is generally required. You can get the complete configure
option list with the `./configure --help' command.

The default installation prefix is /usr/local. You can change it
with the `--prefix=' option.
Expand Down
4 changes: 2 additions & 2 deletions doc/history.d
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Name
history - History For AdvanceMAME/MESS

AdvanceMAME/MESS Version 3.11 2024/02
AdvanceMAME/MESS Version 3.10 2024/02
) Alcon / Slap Fight MCU hookup (#116) [arcadez2003]
) Add the protection MCU for the official Alcon / Slap Fight sets (#115) [arcadez2003]
) Fixed crash with Linux nvidia proprietary driver
Expand Down Expand Up @@ -71,7 +71,7 @@ AdvanceMAME/MESS Version 3.11 2024/02
) apf_vsync_int: fix invalid access to apf_ints variable (#5) [Andreas Oberritter]
) Adding pkg-config for ncurses and slang. (#8) [Alex Barker]

AdvanceMENU Version 3.11 2024/02
AdvanceMENU Version 3.10 2024/02
) Added the new 'ui_menu_font' to change the font for the online menus.

AdvanceMAME/MESS Version 3.9 2018/09
Expand Down
111 changes: 71 additions & 40 deletions doc/install.d
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,72 +28,87 @@ System Requirements
and CRT TVs, is available only from the Linux console, using
the Linux Framebuffer.

Raspberry Pi
With a Raspberry Pi you have the same support you have in Linux,
plus some specific Raspberry functionality, like the accelerated
Raspberry Pi 3
With a Raspberry Pi 3, you have the same support as in Linux, along
with specific Raspberry functionality, such as the accelerated
Framebuffer.

With a Raspberry, it's recommended run the Advance program directly
from Linux Console because using the Linux Framebuffer you also get
hardware acceleration that is missing when run from the X Window system
using the SDL library.
For optimal performance with a Raspberry Pi 3, it's recommended to run
the Advance programs directly from the Linux Console. Utilizing the
Linux Framebuffer provides hardware acceleration, which is not
available when running it from the X Window system using the SDL
library.

This is the best operating mode when using a modern monitor or flat TV,
and it doesn't need any configuration step. It just works.
This operating mode is ideal for use with modern monitors or
flat-screen TVs and requires no additional configuration steps; it
simply works.

With a Raspberry Pi 3 you can expect to run most of the games at
full speed, with vsync enabled, even when using the Scale2x effect.
On a Raspberry Pi 3, you can expect most games to run at full speed
with vsync enabled, even when applying the Scale2x effect.

If instead you want to use an old CRT Arcade or TV screen, you can
configure the Advance programs to generate modelines customized
for your video hardware, following the 'Video Setup' chapter.
If, however, you prefer to use an old Arcade CRT or TV screen, you can
configure the Advance programs to generate custom modelines for your
video hardware, following the instructions in the 'Video Setup'
chapter.

Users have reported achieving optimal results with Arcade CRT by using
the legacy Raspbian stretch, as opposed to the more recent Raspbian
buster and other versions. You can obtain the legacy Raspbian stretch
from the following link:

:http://downloads.raspberrypi.org/raspbian/images/raspbian-2019-04-09/

Additionally, you can download packages by editing the /etc/apt/sources.list
file and adding the following line:

:deb http://legacy.raspbian.org/raspbian/ stretch main contrib non-free rpi

HDMI Port
To use the programmable modelines with the Raspberry HDMI port, you
need a kind of HDMI->VGA or HDMI->SCART converter to connect it to a
CRT monitor.
To utilize programmable modelines with the Raspberry HDMI port, you'll
need an HDMI->VGA or HDMI->SCART converter to connect it to a CRT
monitor.

You don't need any special option in your '/boot/config.txt', just the
options needed to start the Raspberry with your video hardware,
and be able to enter commands.
There's no need for any special options in your '/boot/config.txt';
include only the options required to start the Raspberry with your
video hardware and enable command entry.

Whatever hdmi_mode you select, the Advance programs will use mode 87
group 2, restoring your selected original mode when finished.
Regardless of the hdmi_mode you select, the Advance programs will use
mode 87, group 2, and restore your initially selected mode when
finished.

DPI Port
To use the programmable modelines with the Raspberry DPI port you
need a GPIO add-on board like the Gert's VGA 666.
To use programmable modelines with the Raspberry DPI port, you'll need
a GPIO add-on board such as Gert's VGA 666.

The Raspberry Pi has strong limitations on the lower range of pixel
clocks when using the DPI/GPIO interface, that will affect your
ability to control low frequency monitors, like Arcade screens.
The Raspberry Pi imposes limitations on the lower range of pixel
clocks when using the DPI/GPIO interface, impacting your ability to
control low-frequency monitors like Arcade screens.

The only allowed pixel clocks suitable for low resolutions
are 4.8 MHz, 6.4 MHz, 9.6MHz and 19.2 MHz.
You can instead choose any pixel clock greater than 31.25 MHz.
Allowed pixel clocks suitable for low resolutions are 4.8 MHz, 6.4
MHz, 9.6 MHz, and 19.2 MHz. Alternatively, you can choose any pixel
clock greater than 31.25 MHz.

To overcome this problematic, AdvanceMAME transparently increase
the modeline horizontal size, until it reaches the 31.25 MHz pixel clock.
Don't be surprised if a modeline that works in AdvanceMAME, doesn't
work when setting manually the timings in other ways.
To address this limitation, AdvanceMAME transparently increases the
modeline horizontal size until it reaches the 31.25 MHz pixel clock.
If a modeline works in AdvanceMAME, it might not work when manually
setting timings in other ways.

To have the programmable modes working, you have to start the
Raspberry with the custom mode 87 group 2 in '/boot/config.txt'.
To enable programmable modes, start the Raspberry with custom mode 87
group 2 in '/boot/config.txt'. For example, with an Arcade Monitor:

For example, with an Arcade Monitor, you can use:

:dpi_group=2
:dpi_mode=87
:hdmi_timings=320 1 20 29 35 224 1 10 14 16 0 0 0 60 0 6400000 1

With a standard SVGA Monitor, you can use:
Or with a standard SVGA Monitor:

:dpi_group=2
:dpi_mode=87
:hdmi_cvt=1024 768 60

Usually you have to also add other options, for example with a Raspberry
Pi 3 and a Gert's VGA 666, you need also:
You may also need additional options, such as with a Raspberry Pi 3
and Gert's VGA 666:

:device_tree=bcm2710-rpi-3-b.dtb
:dtparam=i2c_arm=off
Expand All @@ -108,6 +123,22 @@ System Requirements
:dtparam=audio=on
:gpu_mem=128

Raspberry Pi 4
The Raspberry Pi 4 features a new video driver that, unfortunately, no
longer supports direct programming of the Linux FrameBuffer.

To address this issue, you will need to edit the /boot/config.txt file
and comment out the 'dtoverlay=vc4-kms-v3d' line. This action
activates the legacy video driver that still maintains support for the
Linux FrameBuffer (tested with Raspbian bullseye).

However, it's important to note that this support is sufficient for an
LCD screen but potentially inadequate for a real Arcade monitor.

Nevertheless, with the new video driver, it is always possible to run
within the X Window system using the SDL library, albeit not at the
optimal speed.

Windows/Mac OS X
In Windows and Mac OS X, the Advance programs use the SDL library
for video, audio, and input controllers.
Expand Down
27 changes: 21 additions & 6 deletions doc/release.d
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ Name
is based on MAME 0.106, and it needs a romset aligned to
such MAME version.

AdvanceMAME/MENU 3.10
This version includes numerous game improvements contributed by
various individuals. For detailed information, please refer to the
History file.

Additionally, a crash when showing the onscreen menu with NVidia cards
has been fixed.

Moreover, this release introduces partial support for the Raspberry Pi
4. More details can be found in the Install document.

However, it's important to note that this support may not be
sufficient for using a real Arcade monitor. As of now, the Raspberry
Pi 3 remains the recommended and preferred option for this purpose.

AdvanceMAME/MENU 3.8
Many improvements targeted to be able to build a completely
standalone game console using Raspberry Pi hardware.
Expand Down Expand Up @@ -323,9 +338,9 @@ AdvanceMAME 0.62.0 / AdvanceMESS 0.61.2
Simply run "svgawin /u" and "svgawin /l".

AdvanceMAME 0.61.4 / AdvanceMESS 0.61.1
This is the first Windows NT/2000/XP version able to directly
program your video board. This puts the Windows version at the same level
of the other Linux and DOS versions. It's very experimental, and tested only
This is the first Windows NT/2000/XP version able to directly
program your video board. This puts the Windows version at the same level
of the other Linux and DOS versions. It's very experimental, and tested only
with a GeForce 2. Anyway, it should work with all the video boards that
work in DOS and Linux because the SVGA drivers are the same.

Expand All @@ -336,9 +351,9 @@ AdvanceMAME 0.61.4 / AdvanceMESS 0.61.1
version using only the SDL library.

AdvanceMENU 2.2.0
This is the first Windows NT/2000/XP version able to directly
program your video board. This puts the Windows version at the same level
of the other Linux and DOS versions. It's very experimental, and tested only
This is the first Windows NT/2000/XP version able to directly
program your video board. This puts the Windows version at the same level
of the other Linux and DOS versions. It's very experimental, and tested only
with a GeForce 2. Anyway, it should work with all the video boards that
work in DOS and Linux because the SVGA drivers are the same.

Expand Down

0 comments on commit 821679c

Please sign in to comment.