diff --git a/formats/86f.rst b/formats/86f.rst index 44680ed..024358b 100644 --- a/formats/86f.rst +++ b/formats/86f.rst @@ -1,7 +1,7 @@ 86F === -A floppy disk image format which stores data in FM- or MFM-encoded transitions. +A floppy disk surface image format which stores data in FM- or MFM-encoded transitions. Preliminary specification for v2.20 ----------------------------------- diff --git a/index.rst b/index.rst index ac95fcb..60200c7 100644 --- a/index.rst +++ b/index.rst @@ -29,7 +29,8 @@ to retro computing and, of course, 86Box. We look forward to hearing from you! :caption: Using 86Box usage/gettingstarted - usage/menu + usage/menubar + usage/statusbar settings/index usage/machinespecific usage/diskimages diff --git a/settings/floppycdrom.rst b/settings/floppycdrom.rst index 6da7a93..a40b7eb 100644 --- a/settings/floppycdrom.rst +++ b/settings/floppycdrom.rst @@ -1,7 +1,7 @@ Floppy & CD-ROM drives ====================== -The *Floppy & CD-ROM drives* page contains settings related to the emulated machine's base removable devices. +The *Floppy & CD-ROM drives* page contains settings related to the emulated machine's base removable storage drives. Floppy drives ------------- diff --git a/settings/removable.rst b/settings/removable.rst index dbf321d..d459960 100644 --- a/settings/removable.rst +++ b/settings/removable.rst @@ -1,7 +1,7 @@ Other removable devices ======================= -The *Other removable devices* page contains settings related to the emulated machine's additional removable devices. +The *Other removable devices* page contains settings related to the emulated machine's additional removable storage drives. MO / ZIP drives --------------- diff --git a/settings/sound.rst b/settings/sound.rst index a4176a9..d7ca47b 100644 --- a/settings/sound.rst +++ b/settings/sound.rst @@ -17,8 +17,7 @@ Device to output MIDI music to, for sound cards equipped with an external MIDI o * **None:** don't output MIDI music. * **FluidSynth:** a software soundfont synthesizer. The FluidSynth library file must be present in the 86Box directory, and a soundfont must be configured. -* **Roland MT-32 Emulation:** emulate a Roland MT-32 synthesizer device. Emulation is provided by the `Munt `_ library. -* **Roland CM-32L Emulation:** same as above, but emulating a Roland CM-32L instead. +* **Roland MT-32**/**CM-32L Emulation:** emulate a Roland MT-32 or CM-32L synthesizer device. Emulation is provided by the `Munt `_ library. * **System MIDI:** output to a (configurable) host MIDI device, such as the Windows software synthesizer or a USB MIDI adapter. The *Configure* button opens a new window with settings specific to the selected output device. diff --git a/usage/gettingstarted.rst b/usage/gettingstarted.rst index de22c93..ab2b715 100644 --- a/usage/gettingstarted.rst +++ b/usage/gettingstarted.rst @@ -11,9 +11,9 @@ Here are the basic steps to help you get started with 86Box. The user interface Once you got the romset in the right place, you can start ``86Box.exe``. The main window has three important areas: -* **The menu bar at the top**, where most controls and options are located. See :doc:`menu` for more information. +* **The menu bar at the top**, where most controls and options are located. See :doc:`menubar` for more information. * **The display area in the middle**, which is where the display output from the emulated machine will be rendered. -* **The status bar at the bottom**, containing icons for quickly accessing the configured peripheral devices. +* **The status bar at the bottom**, containing icons for quickly accessing the configured peripheral devices. See :doc:`statusbar` for more information. .. rubric:: Step 3: Configure the hardware @@ -25,19 +25,7 @@ Once you've selected the hardware components you wish to emulate, you need to ma .. rubric:: Step 5: Mount some images -Now that you've configured everything, you're ready to run some software in your virtual machine. Maybe you want to install an operating system or play a booter game. In any case, you'll have to mount some virtual media to get going. You can do this with the icons in the status bar. Icons representing removable media appear semi-transparent when their associated drive is empty, and fully opaque when media is inserted. - -Depending on the hardware configuration you've chosen, you may or may not see the following icons in the status bar, from left to right: - -* **Floppy disk:** the icon is different for 3.5" and 5.25" floppy disk drives. This also determines the kind of floppy disk images you can use with a particular drive. You can have up to 4 floppy drives configured, though BIOS limitations also apply. To mount a floppy disk image, click on the floppy disk icon, select *Existing image...*, and select the disk image you wish to mount. -* **CD-ROM:** this represents the CD-ROM drive you've configured, you can have up to 4 drives. To mount a disk image, click on the icon and select *Image...*, then select the image you wish to mount. -* **ZIP disk:** represents the Iomega ZIP drive, also up to four drives. The mounting procedure is the same in this case as well, click on the icon, select *Existing image...* and select your ZIP disk image. -* **MO disk:** represents the Magneto-Optical drive, which works very similarly to the ZIP drive above. -* **Hard disk drive:** currently only there to let you know that a hard disk drive has been configured. If you hover over it, the tooltip will tell you which interface was selected for this particular drive. You could theoretically have an unlimited number of hard disk drives, but interface and BIOS limitations prevent this. -* **Network:** will only be present if you've enabled a network interface. It doesn't do anything yet other than let you know that networking capability has been enabled. -* **Sound:** always present. Double-click it to adjust the sound gain level. - -Icons will also flash a small green dot every now and then. This means the particular piece of hardware associated with the icon is in use; for example, the data on the hard disk drive is being read or written. +Now that you've configured everything, you're ready to run some software in your virtual machine. Maybe you want to install an operating system or play a booter game. In any case, you'll have to mount some virtual media to get going. You can do this with the icons in the :doc:`status bar `. Icons representing removable media appear semi-transparent when their associated drive is empty, and fully opaque when media is inserted. When you want to eject virtual media, click on the particular icon again and select *Eject* (for floppy and ZIP disks) or *Empty* (for CD-ROMs). The icon becomes semi-transparent again. diff --git a/usage/images/cdrom.png b/usage/images/cdrom.png new file mode 100644 index 0000000..2e1ecb9 Binary files /dev/null and b/usage/images/cdrom.png differ diff --git a/usage/images/floppy_35.png b/usage/images/floppy_35.png new file mode 100644 index 0000000..0406250 Binary files /dev/null and b/usage/images/floppy_35.png differ diff --git a/usage/images/floppy_525.png b/usage/images/floppy_525.png new file mode 100644 index 0000000..57f6cf1 Binary files /dev/null and b/usage/images/floppy_525.png differ diff --git a/usage/images/hard_disk.png b/usage/images/hard_disk.png new file mode 100644 index 0000000..5936c30 Binary files /dev/null and b/usage/images/hard_disk.png differ diff --git a/usage/images/mo.png b/usage/images/mo.png new file mode 100644 index 0000000..54e9319 Binary files /dev/null and b/usage/images/mo.png differ diff --git a/usage/images/network.png b/usage/images/network.png new file mode 100644 index 0000000..2aabf85 Binary files /dev/null and b/usage/images/network.png differ diff --git a/usage/images/sound.png b/usage/images/sound.png new file mode 100644 index 0000000..7e06d0d Binary files /dev/null and b/usage/images/sound.png differ diff --git a/usage/images/zip.png b/usage/images/zip.png new file mode 100644 index 0000000..98a5dce Binary files /dev/null and b/usage/images/zip.png differ diff --git a/usage/menu.rst b/usage/menubar.rst similarity index 92% rename from usage/menu.rst rename to usage/menubar.rst index 0f379fe..efed1bd 100644 --- a/usage/menu.rst +++ b/usage/menubar.rst @@ -6,7 +6,7 @@ The menu bar located at the top of the 86Box window provides controls for the em Action ------ -* **Right CTRL is left ALT:** let the right Ctrl key act as a left Alt key, to match some special keyboards where the Alt key is located on the right side of the space bar. +* **Right CTRL is left ALT:** let the right Ctrl key act as a left Alt key, to simulate some special keyboards where the Alt key is located on the right side of the space bar. * **Hard reset:** force a reset of the emulated machine. Requires confirmation. * **Ctrl+Alt+Del:** send a *Ctrl+Alt+Del* key combination to the emulated machine. You can alternatively press *Ctrl+F12* to send that combination. * **Ctrl+Alt+Esc:** send a *Ctrl+Alt+Esc* key combination to the emulated machine. @@ -47,7 +47,7 @@ Tools ----- * **Settings:** open the :doc:`Settings <../settings/index>` window. -* **Update status bar icons:** enable the blinking lights on :doc:`status bar ` icons. Unchecking this may improve emulation performance on low-end host systems. +* **Update status bar icons:** enable the activity lights on :doc:`status bar ` icons. Unchecking this option may improve emulation performance on low-end host systems. * **Enable Discord integration:** enable Discord Rich Presence. Other Discord users will know that you're running 86Box, as well as the names of the virtual machine directory, emulated machine and emulated CPU you're using. * **Take screenshot:** take a screenshot of the emulated display. Screenshots are saved as PNG images in the ``screenshots`` directory. diff --git a/usage/statusbar.rst b/usage/statusbar.rst new file mode 100644 index 0000000..2a5a3e9 --- /dev/null +++ b/usage/statusbar.rst @@ -0,0 +1,72 @@ +Status bar +========== + +The status bar located at the bottom of the 86Box window provides icons related to devices attached to the emulated machine. Move your mouse cursor over an icon to see what device it represents. **Most icons can be clicked on** to access options related to their respective devices, as listed below. Additionally, a green indicator light will appear on an icon when its device is in use, unless :ref:`Update status bar icons ` is disabled. + +.. |nbsp| unicode:: 0xA0 0xA0 + :trim: +.. |floppy_35| image:: images/floppy_35.png + :scale: 150% +.. |floppy_525| image:: images/floppy_525.png + :scale: 150% +.. |cdrom| image:: images/cdrom.png + :scale: 150% +.. |zip| image:: images/zip.png + :scale: 150% +.. |mo| image:: images/mo.png + :scale: 150% +.. |hard_disk| image:: images/hard_disk.png + :scale: 150% +.. |network| image:: images/network.png + :scale: 150% +.. |sound| image:: images/sound.png + :scale: 150% + +|floppy_35| |floppy_525| |nbsp| Floppy drives +--------------------------------------------- + +A 3.5" or 5.25" floppy icon will appear for each configured :ref:`floppy drive `. + +* **New image:** create a new disk image file. Opens the *New Image* window, which lets you select the image size and where to save the file. +* **Existing image:** insert a disk image file into this drive. +* **Existing image (Write-protected):** insert a disk image file into this drive as a read-only disk. +* **Export to 86F:** convert the currently-inserted disk image file to 86Box's :doc:`../formats/86f` surface image format. You will be asked where to save the converted file. +* **Eject:** remove the currently-inserted disk from this drive. + +|cdrom| |nbsp| CD-ROM drives +---------------------------- + +A CD icon will appear for each configured :ref:`CD-ROM drive `. + +* **Mute:** mute any :ref:`usage/diskimages:CD audio` played through this drive. **CD audio is muted by default on all drives.** +* **Empty:** remove any disc inserted into this drive. +* **Reload previous image:** reinsert the last disc image file selected through the *Image* option. +* **Image:** insert a CD-ROM or DVD-ROM disc image into this drive. + +|zip| |mo| |nbsp| ZIP and MO drives +----------------------------------- + +A ZIP or MO icon will appear for each configured :doc:`additional removable storage drive <../settings/removable>`. + +* **New image:** create a new disk image file. Opens the *New Image* window, which lets you select the image size and where to save the file. +* **Existing image:** insert a disk image file into this drive. +* **Existing image (Write-protected):** insert a disk image file into this drive as a read-only disk. +* **Eject:** remove the currently-inserted disk from this drive. +* **Reload previous image:** reinsert the last disk image file selected through the *Existing image* options. + +|hard_disk| |nbsp| Hard disks +----------------------------- + +A hard disk icon will appear for each configured :doc:`hard disk bus <../settings/hdd>`. For example, if you have both IDE and SCSI hard disks configured, two hard disk icons will appear: one representing all IDE disks, and another one representing all SCSI disks. No options are available. + +|network| |nbsp| Network +------------------------ + +This icon will appear if :doc:`networking <../settings/network>` is enabled. No options are available. + +|sound| |nbsp| Sound +-------------------- + +This icon is always present. Double-clicking it opens a sound gain control, which allows you to increase the loudness of all audio produced by the emulated machine, including the PC speaker and any sound cards. + +.. note:: The gain control does not apply to MIDI music sent to a software synthesizer through the :ref:`System MIDI ` device, as these synthesizers are external to 86Box. \ No newline at end of file