mirror/86Box-docs
1
0
Fork 0
mirror of https://github.com/86Box/docs.git synced 2026-02-21 09:05:33 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add ROM set documentation

Browse Source
This commit is contained in:
David Hrdlička
2022-04-21 05:28:25 +02:00
parent fdc6e329ca
commit 4364b172c8
2 changed files with 46 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
usage/gettingstarted.rst
View File

@@ -3,9 +3,9 @@ Getting started
Here are the basic steps to help you get started with 86Box. The user interface has been designed to resemble Virtual PC, VirtualBox and other virtualizers, so if you used those programs before, this should all look familiar to you.
.. rubric:: Step 1: Get the romset
.. rubric:: Step 1: Get the ROM set
86Box relies on a bunch of external binary files, called ROMs, to emulate various hardware. Together, these files are known as the *romset*. If you try to start 86Box without one, you'll receive an error and 86Box will close. You need to download the romset from `here <https://github.com/86Box/roms/releases/latest>`_. If you're using a Windows machine, create a subfolder named ``roms`` in the folder where ``86Box.exe`` is located, and extract the romset there. If you're using a macOS machine, create a folder with the following path ``~/Library/Application Support/net.86box.86box/roms`` and extract the romset into it.
86Box relies on a set of ROM dumps gathered from physical hardware to emulate it. This includes the system BIOS, as well as any option ROMs used by extension cards. If you try to start 86Box without one, you'll receive an error and 86Box will close. You need to download the ROM set from `here <https://github.com/86Box/roms/releases/latest>`_, and extract it into one of the :doc:`supported locations <roms>`.
.. rubric:: Step 2: Meet the main window

44
usage/roms.rst Normal file
View File

@@ -0,0 +1,44 @@
ROM set
=======
86Box relies on a set of ROM dumps gathered from physical hardware to emulate it. This includes the system BIOS, as well as any option ROMs used by extension cards.
The ROM set is organized into several directories for each device type, each of which contains futher subdirectories for each machine or device model or category.
.. note:: The expected file names of the ROM dumps and their locations within the set are hardcoded in the emulator. If you rename them or add your own dumps with different file names, the emulator will not be able to make use of them.
Search path
-----------
The emulator utilizes a search path mechanism to locate ROMs. By default, the following locations are considered:
1. ``roms`` subdirectory in the VM path
2. ``roms`` subdirectory in the same directory as the emulator executable
3. Platform-specific locations
A custom location can be specified by using the ``-R`` or ``--rompath`` command line argument, which then precedes any other considered locations.
.. rubric:: Windows
The following locations are searched on Windows:
1. ``%LOCALAPPDATA%\86Box\roms``
2. ``%PROGRAMDATA%\86Box\roms``
.. rubric:: Unix
86Box honors the XDG base directory specification on Linux and other Unix-compatible platforms. The following locations are searched:
1. ``$XDG_DATA_HOME/86Box/roms``
2. ``86Box/roms`` subdirectory in each path listed in ``$XDG_DATA_DIRS``
This usually resolves to ``~/.local/share/86Box/roms``, ``/usr/local/share/86Box/roms`` and ``/usr/share/86Box/roms`` (in order).
.. rubric:: macOS
The following locations are searched on macOS:
1. ``~/Library/Application Support/net.86box.86Box/roms``
2. ``/Library/Application Support/net.86box.86Box/roms``
.. tip:: The list of all paths searched when loading ROMs is printed to the log and standard output when 86Box starts.