summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/initialsetup/configuringmame.rst
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2021-05-07 03:41:10 +1000
committer Vas Crabb <vas@vastheman.com>2021-05-07 03:41:10 +1000
commit73cd2b55b876dbf57b8318fa6ae46b0c268d547f (patch)
tree824731933951bf65e57eddb3c842d86b349bac4c /docs/source/initialsetup/configuringmame.rst
parentfc77338e37b416d1fbf1f17409a81aa8039d3fed (diff)
Docmumentation update/expansion. [Firehawke, Vas Crabb]
Diffstat (limited to 'docs/source/initialsetup/configuringmame.rst')
-rw-r--r--docs/source/initialsetup/configuringmame.rst77
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/source/initialsetup/configuringmame.rst b/docs/source/initialsetup/configuringmame.rst
new file mode 100644
index 00000000000..3a0c8830cdf
--- /dev/null
+++ b/docs/source/initialsetup/configuringmame.rst
@@ -0,0 +1,77 @@
+Configuring MAME
+================
+
+.. contents:: :local:
+
+Getting Started: A Quick Preface
+--------------------------------
+
+Once you have MAME installed, the next step is to configure it. There are
+several ways to do this, and each will be covered in turn.
+
+If you are on Windows, the MAME executable will be called ``mame.exe``.
+
+If you are on Linux or MacOS, the MAME executable will be called ``mame``.
+
+
+Initial Setup: Creating mame.ini From Command Line on Windows
+-------------------------------------------------------------
+
+First, you will need to *cd* to the directory where you installed MAME into.
+If, for instance, you have MAME installed in ``C:\Users\Public\MAME`` you will
+need to type ``cd C:\Users\Public\MAME`` into the command prompt.
+
+Then you have MAME create the config file by typing ``mame64 -createconfig``
+or ``mame -createconfig`` depending on if you are using the 64-bit version of
+MAME or the 32-bit version.
+
+MAME will then create the ``mame.ini`` file in the MAME installation folder.
+This file contains the default configuration settings for a new MAME
+installation.
+
+
+Initial Setup: Creating mame.ini From Command Line on Linux or MacOS
+--------------------------------------------------------------------
+
+The steps for Linux and MacOS are similar to those of Windows. If you
+installed MAME using the package manager that came from a Linux distro, you will
+type ``mame64 -createconfig`` or ``mame -createconfig`` into your terminal
+of choice, depending on if you have a 64-bit version of MAME or a 32-bit
+one.
+
+If you have compiled from source or downloaded a binary package of MAME,
+you will ``cd`` into the directory you put the MAME files into.
+
+For instance, ``cd /home/myusername/mame``
+
+Then you will type ``./mame64 -createconfig`` or ``./mame -createconfig`` into
+your terminal of choice, depending on if you have a 64-bit version of MAME or a
+32-bit one.
+
+You can then need to edit the ``mame.ini`` file in your favorite text editor,
+e.g. *Notepad* on Windows or *vi* on Linux/MacOS, or you can change settings
+from inside of MAME.
+
+
+Initial Setup: Graphical Setup
+------------------------------
+
+This is the easiest way to get started. Start MAME by opening the MAME icon
+in the location where you installed it. This will be ``mame64.exe`` or
+``mame.exe`` on Windows, ``mame64`` or ``mame`` on Linux and macOS.
+
+Once MAME has started, you can either use your mouse to click on the
+**Configure Options** menu selection at the bottom center of your screen,
+or you can switch panes to the bottom one (default key is Tab), then press
+the menu accept button (default key is Return/Enter) to go into the
+Configuration menu.
+
+Choose **Save Configuration** to create the ``mame.ini`` file with default
+settings. From here, you can either continue to configure things from the
+graphical user interface or edit the ``mame.ini`` file in your favorite
+text editor.
+
+
+Configuring MAME
+----------------
+