Differences

This shows you the differences between two versions of the page.

--- systems:dos [2021/05/30 15:31] – ↷ Page moved from emulators:dos to systems:dos igno2k
+++ systems:dos [2026/01/24 18:13] (current) – explains dosz suffix crcerror
@@ Line 1: / Line 1: @@
-===== A word of warning =====
+<WRAP group>
+<WRAP round box twothirds column>
+{{ https://raw.githubusercontent.com/fabricecaruso/es-theme-carbon/master/art/logos/pc.svg?nolink&300 }}
-Emulating DOS games is by far the most complicated thing to emulate on Batocera.\\
+====== MS-DOS (x86) ======
-If you never used DOS or at not familiar at all with command line and file edition, I suggest to download the ExoDOS Collection and use my [[https://github.com/Voljega/ExoDOSConverter|ExoDOSConverter ]] which will generate fully functionning DOS games for you (bugs nothwithstanding off course).\\
-If you want to do it manually or wants to know more about DOS emulation and tweaking, here's a little run down\\
+Before Windows, Microsoft made a handy little Disc-based Operating System (MS-DOS, commonly referred to as just "DOS"). Lots of people used it for lots of things, but that also included //videogames//. We're interested in that aspect, especially since you can't just run these old games on modern operating systems anymore.
-Please also note that the different DOS emulators in Batocera are in the process of beeing reviewed and upgraded, and some of them are a bit twitchy.\\
+<WRAP center round important>
-For safer result you better stick at the moment with basic dosbox emulator\\
+Emulating DOS games is by far the most complicated thing to emulate on Batocera.
-===== DOSBox Emulation : Basic rundown =====
+If new to DOS emulation, it is recommended to use the ExoDOS Collection along with Voljega's [[https://github.com/Voljega/ExoDOSConverter|ExoDOSConverter]]. This will generate fully functional DOS games ready to play.
-Here's a simple example with the game Alley Cat :
+Please also note that the different DOS emulators in Batocera are in the process of being reviewed and upgraded, and some of them are a bit twitchy.
+</WRAP>
+This system scrapes metadata for the "pc" group(s) and loads the ''pc'' set from the currently selected theme, if available.
+</WRAP>
+<WRAP third column>
+{{ https://raw.githubusercontent.com/fabricecaruso/es-theme-carbon/master/art/consoles/pc.png?nolink&350 |}}
+</WRAP>
+</WRAP>
+==== Quick reference ====
+  * **Accepted ROM formats:** ''.pc'', ''.dos'', ''.zip'', ''.squashfs'', ''.dosz'', ''.m3u'', ''.iso'', ''.cue''
+  * **Folder:** ''/userdata/roms/dos''
+^ Emulators ^ Accepted ROM formats ^
+| [[#dosbox|DOSBox]] | ''.pc'', ''.dos'', ''.squashfs'', ''.dosz'', ''.m3u'', ''.iso'', ''.cue'' |
+| [[#dosbox_staging|DOSBox_staging]] | ''.pc'', ''.dos'', ''.squashfs'', ''.dosz'', ''.m3u'', ''.iso'', ''.cue'' |
+| [[#dosbox-x|DOSBox-X]] | ''.pc'', ''.dos'', ''.squashfs'', ''.dosz'', ''.m3u'', ''.iso'', ''.cue'' |
+| [[#libretro:_dosbox_pure|libretro: DOSBox_Pure]] | ''.pc'', ''.dos'', ''.zip'', ''.squashfs'', ''.dosz'', ''.m3u'', ''.iso'', ''.cue'' |
+===== BIOS =====
+No DOS emulator in Batocera needs a BIOS file to run.
+===== Game files =====
+Place your DOS game files in its own folder in ''/userdata/roms/dos'' with the ''.pc'' extension. For example: ''roms/dos/WackyWheels.pc/''.
+How exactly they are setup and what additional configuration is require depends on which emulator you use. For first time users, [[#libretro:_dosbox_pure|libretro: DOSBox_Pure]] is recommended.
+<WRAP center round tip>
+If intending on using DOSBox_Pure, ''.zip'' files can be renamed to ''.dosz'' (It is a relict from the libretro frontend that wants to load the content of ''.ZIP'' files instead of sending it to DOSBox Pure to load. This was especially useful for CD images in ZIP format which RetroArch refuses to append through its Disc Control menu. So for fun? ... FIXME - yes it is rather a joke because BATOCERA is an advanced launcher where each system is separated and a dependency to a file suffix does not exists).
+In addition, to mount a ZIP file as the virtual ''A:'' or ''D:'' drive the ''.zip'' file can be renamed to ''.d.zip''.
+</WRAP>
+===== Emulators =====
+==== DOSBox ====
+The most standard version of DOSBox. Can be a bit unwieldy to use for newcomers, but it provides the most "pure" experience of DOSBox. Those already familiar with DOSBox will be right at home.
+Requires [[#dosbox_standalone_preparation|some setup]] before games can be run in it.
+<WRAP center round tip>
+New users are recommended to use [[#libretro:_dosbox_pure|libretro: DOSBox_Pure]] instead when starting out.
+</WRAP>
+=== DOSBox configuration ===
+Standardized features available to all cores of this emulator: ''dos.videomode'', ''dos.ratio'', ''dos.padtokeyboard''
+==== DOSBox_Staging ====
+[[https://dosbox-staging.github.io/|DOSBox Staging]] is a fork aimed at ease-of-use. Prioritizes running games, while still striking a balance between emulation quality, speed, and usability.
+=== DOSBox_Staging configuration ===
+Standardized features available to all cores of this emulator: ''dos.videomode'', ''dos.ratio'', ''dos.padtokeyboard''
+There are no configuration options available yet.
+==== DOSBox-X ====
+Vastly different from all the other forks, [[https://dosbox-x.com/|DOSBox-X]] aims to support Windows 3.x, 9x and ME games in addition to all the already emulatable DOS games.
+<WRAP center round todo>
+How do you use this, though?
+</WRAP>
+==== RetroArch ====
+RetroArch has [[emulators:retroarch|its own page]].
+=== libretro: DOSBox_Pure ===
+Noob-friendly DOSBox, [[https://github.com/schellingb/dosbox-pure|DOSBox Pure]] aims for simplicity and ease of use. Aims at automating the entire process, including pre-configuring everything you might need for a game such as input mapping and batch script creation. This core doesn't require as much setup as the others do, and leverages RetroArch's functionality in addition to DOSBox's. Notably, when launching a game's folder DOSBox Pure will prompt the user for which executable file to launch, instead of requiring a run command to be typed out manually and saved to a file using external tools.
+Because of its automated nature, it can be difficult to handle issues when they arise. If a particular game you have doesn't work with DOSBox Pure, it is recommended to try them on the standalone DOSBox emulators (after properly setting them up for them, of course).
+While in DOSBok_Pure, run ''REMOUNT C: D:'' to remount the loaded game files in the ''D:'' drive.
+== libretro: DOSBox_Pure configuration ==
+^ ES setting name ''batocera.conf_key'' ^ Description => ES option ''key_value'' ^
+^ Settings that apply to all systems this core supports ||
+| **CPU TYPE ''global.pure_cpu_type''** | Select the fine CPU type for your game\\ => Autodetect (Compatible) ''automatic'', 386 ''386'', 386 (slow) ''386_slow'', 386 (prefetch) ''386_prefetch'', 486 (slow) ''486_slow'', Pentium (slow) ''pentium_slow''. |
+| **CPU CORE METHOD ''global.pure_cpu_core''** | Choose an accurate or fast method\\ => Optimized (auto) ''automatic'', Dynamic (fast) ''dynamic'', Normal (interpreter) ''normal'', Simple (interpreter for old real-mode games) ''simple''. |
+| **CPU EMULATED PERFORMANCE ''global.pure_cycles''** | Select CPU cycles by model (use with caution)\\ => Autodetect (Compatible) ''automatic'', MAX (as many as possible) ''max'', 8086/8088, 4.77MHz (315 cps) ''315'', 286, 6MHz (1320 cps) ''1320'', 286, 12.5MHz (2750 cps) ''2750'', 386, 20MHz (4720 cps) ''4720'', 386DX, 33MHz (7800 cps) ''7800'', 486DX, 33MHz (13400 cps) ''13400'', 486DX2, 66MHz (26800 cps) ''26800'', Pentium, 100MHz (77000 cps) ''77000'', Pentium II, 300MHz (200000 cps) ''200000'', Pentium III, 600MHz (500000 cps) ''500000'', AMD Athlon, 1.2GHz (1000000 cps) ''1000000''. |
+| **RAM SIZE ''global.pure_memory_size''** | The amount of RAM for the emulated machine\\ => No EMS/XMS ''none'', 4MB ''4'', 8MB ''8'', 16MB ''16'', 24MB ''24'', 32MB ''32'', 48MB ''48'', 64MB ''64'', 96MB ''96'', 128MB ''128'', 224MB ''224''. |
+| **GRAPHICS CHIP TYPE ''global.pure_machine''** | Video card graphic chip type\\ => SVGA ''svga'', VGA ''vga'', EGA ''ega'', CGA ''cga'', Tandy ''tandy'', Hercules ''hercules'', PCjr ''pcjr''. |
+| **KEYBOARD LAYOUT ''global.pure_keyboard_layout''** | Select physical keyboard layout (not the On-Screen one)\\ => US ''us'', UK ''uk'', Brazil ''br'', Croatia ''hr'', Czech Republic ''cz243'', Denmark ''dk'', Finland ''su'', France ''fr'', Germany ''gm'', Greece ''gr'', Hungary ''hu'', Iceland ''is161'', Italy ''it'', Netherlands ''nl'', Norway ''no'', Poland ''pl'', Portugal ''po'', Russia ''ru'', Slovakia ''sk'', Slovenia ''si'', Spain ''sp'', Sweden ''sv'', Switzerland (German) ''sg'', Switzerland (French) ''sf'', Turkey ''tr''. |
+| **SAVESTATE / REWIND ''global.pure_savestate''** | Enable Savestate and optionally Rewind support\\ => On ''True'', On with rewind support ''rewind'', Off ''disabled''. |
+| **GAMEPAD AUTOMATIC MAPPING ''global.pure_auto_mapping''** | Apply a gamepad mapping scheme for selected game\\ => On ''true'', On with game detection message ''notify'', Off ''false''. |
+| **JOYSTICK ANALOG DEADZONE ''global.pure_joystick_analog_deadzone''** | Set the deadzone of the joystick analog sticks\\ => 0% ''0'', 5% ''5'', 10% ''10'', 15% ''15'', 20% ''20'', 25% ''25'', 30% ''30'', 35% ''35'', 40% ''40''. |
+| **JOYSTICK TIMED INTERVAL ''global.pure_joystick_timed''** | Enable timed intervals for joystick axes if drifts\\ => On ''true'', Off ''false''. |
+| **CONTROLLER 1 TYPE ''global.controller1_dosbox_pure''** | Select Keyboard, Joysticks or Gravis GamePad mode\\ => Gravis GamePad (D-pad + 4 Btns) ''1'', Generic Keyboard Binds ''257'', Keyboard + Mouse (Left An.) ''513'', Keyboard + Mouse (Right An.) ''769'', 1st Joystick (2 Axes, 2 Btns) ''1281'', Flight Stick (3 Axes, 4 Btns, 1 Hat) ''1793'', Both Joysticks (4 Axes, 4 Btns) ''2049'', Custom Keyboard Binds (best for Pad2Key) ''3''. |
+| **CONTROLLER 2 TYPE ''global.controller2_dosbox_pure''** | Select Keyboard, Joysticks or Gravis GamePad mode\\ => Gravis GamePad (D-pad + 4 Btns) ''1'', Generic Keyboard Binds ''257'', Keyboard + Mouse (Left An.) ''513'', Keyboard + Mouse (Right An.) ''769'', 2nd Joystick (2 Axes, 2 Btns) ''1537'', Flight Stick (3 Axes, 4 Btns, 1 Hat) ''1793'', Both Joysticks (4 Axes, 4 Btns) ''2049'', Custom Keyboard Binds (best for Pad2Key) ''3''. |
+===== DOSBox standalone preparation =====
+<WRAP center round tip>
+New users should first use [[#libretro: dosbox_pure|DOSBox_Pure]]. It does not require this same level of setup, just put your game's files in a ''dos/<game name>.pc/'' folder and run it.
+</WRAP>
+The standalone DOSBox versions require some setup for each game before they can be run.
+Here's a simple example with the game Alley Cat:
   * Start by creating a folder for your game named ''AlleyCat.pc''. The first part of the folder name before the '.' must have equal or less than 8 characters and avoid special characters.
   * Inside it create a ''dosbox.bat'' file and edit it to call the executable of the game (For big games it's better to install them on your computer before copying them to Batocera).\\ Here for Alley Cat that gives us:
@@ Line 26: / Line 136: @@
 {{:emulators:alleycat.jpg?direct&200|}}
+==== DOSBox Emulation: Advanced rundown ====
-===== DOSBox Emulation : Advanced rundown =====
 Adding a custom ''dosbox.cfg'' in your game folder alongside ''dosbox.bat'' will allow you to specify custom DOSBOX configuration for the game.\\
@@ Line 40: / Line 150: @@
 {{:emulators:duke3d.jpg?direct&200|}}
-===== Converting a DOS game to be used on Batocera =====
+==== Converting a DOS game to be used on Batocera ====
-You might want to convert a game already using DOSBox, like when bought on GOG or games from the excellent ExoDOS collection.\\
+You might want to convert a game already using DOSBox, like when bought on GOG or games from the excellent ExoDOS collection.
-If you are using ExoDOS collection, I can only recommand once again [[https://github.com/Voljega/ExoDOSConverter|ExoDOSConverter ]]
-Anyway, if you want to do it manually, here is the process:\\
+If you are using ExoDOS collection, I can only recommand once again [[https://github.com/Voljega/ExoDOSConverter|ExoDOSConverter]].
-The first step is to copy the content of the game folder.\\
+Anyway, if you want to do it manually, here is the process:
-Then we need to adapt the content of the ''dosbox.cfg'' and the bat file used to launch the game.\\
+The first step is to copy the content of the game folder.
-Let's take an example with WackyWheels\\
-Do not directly copy the ''dosbox.cfg'' (or .conf) from the original folder as this can lead to crashing bugs not easily debugged, copy the standard one linked above and then if you encounter any trouble, just see if the original ''dosbox.cfg'' had any special configuration and try to use it to your ''dosbox.cfg''\\
+Then we need to adapt the content of the ''dosbox.cfg'' and the bat file used to launch the game.
+Let's take an example with WackyWheels.
+Do not directly copy the ''dosbox.cfg'' (or .conf) from the original folder as this can lead to crashing bugs not easily debugged, copy the standard one linked above and then if you encounter any trouble, just see if the original ''dosbox.cfg'' had any special configuration and try to use it to your ''dosbox.cfg''
+First move the content of the ''[autoexec]'' part from the ''doxbox.cfg'' part to the beginning of your ''dosbox.bat'' and adapt paths. Here we have originally:
-First move the content of the ''[autoexec]'' part from the ''doxbox.cfg'' part to the beginning of your ''dosbox.bat'' and adapt paths. Here we have originally :
 <code>
 [autoexec]
@@ Line 76: / Line 189: @@
 </code>
-The content of your ''WackyWhe.pc'' folder should look like that:\\
+The content of your ''WackyWhe.pc'' folder should look like that:
- (Don't mind the ''Wacky Wheels (1994).ba1'' file and ''mapper.map'' is perfectly optional)\\
+(Don't mind the ''Wacky Wheels (1994).ba1'' file and ''mapper.map'' is perfectly optional)
 {{:emulators:wackywheels.jpg?direct&200|}}
-==== Explanations : =====
+==== Explanations: ====
   * ''C:'' is already mounted by Batocera DOSBox, so no need for that
   * '.' is also set by Batocera DOSBox to the game folder, by using relative paths your game won't be linked to a folder (you can put in a subfolder or in a different distribution)
@@ Line 89: / Line 204: @@
   * ''@ww'' is changed to ''WW.EXE'' (just the executable file of the game)
-That's it !\\
+That's it!
-Some games may use a bat file launcher which you can adapt too, put its instruction after those of ''dosbox.cfg'''s ''[autoexec]'' if the original game uses both files.\\
-==== Troubleshooting ====
+Some games may use a bat file launcher which you can adapt too, put its instruction after those of ''dosbox.cfg'''s ''[autoexec]'' if the original game uses both files.
-**Image isn't in the right ratio :** For older games, you may have to adjust the ''aspect=false'' parameter to ''aspect=true'' to get the correct 4/3 ratio. Be aware that on newer games this may lead to performance problems
+==== Windows 3.1 emulation ====
-**Joystick is moving by itself :** Try modifying ''timed=false'' to ''timed=true''. Can be caused by deadzone too and sadly there is no way to configure deadzone on joystick in DOSBox at the moment
+It's also possible to emulate Windows 3.1 games with dosbox, the safest way is to get them from the ExoWin3x collection.
-**D-pad is not usable on xbox60 controller through the mapper :** yeah, it is usable in the mapper, but it doesn't seem to work in-game, I know mate :(
+You can also convert them with [[https://github.com/Voljega/ExoDOSConverter|ExoDOSConverter ]]
-**How an i set my joystick's deadzone :** Sadly it doesn't seem to be possible in standard dosbox at the moment
+===== Controller =====
-**CD Not Found / CD Driver not present :** you likely forgot to rename cd files with non-dos names (see adv. rundown)
+Most if not all DOS games offered keyboard controls, as that was the one accessory universally available to all computers. It is perfectly fine to use pad2key to bind your physical controller to the virtual keyboard. However, there was one particular PC gamepad controller that could be plugged into the serial port of a MSDOS machine and was somewhat universal, the Gravis PC Gamepad: {{ :systems:gravis_gamepad.png?200 |}}
-**I can get mount a or mount d to work :** contrary to imgmount, mount is not able to use 'virtual' path from inside the dosbox machine, so for the mount command to work, you need to only use a real local path from the batocera file system. Given that '.' is set to the root / directory when DOSBox is launched you have to specify the full absolute path
+For this reason it might be why you see some "colored circle" controller prompts in some games. Blue = {{:wiki:north.png?nolink&20|North button (X SNES)}}, Red = {{:wiki:west.png?nolink&20|West button (Y SNES)}}, Yellow = {{:wiki:south.png?nolink&20|South button (B SNES)}} and Green = {{:wiki:east.png?nolink&20|East button (A SNES)}}.
-**The mapper is bugged, it erases my configuration or mix buttons** You're likely victim of the ''buttonwrap'' parameter in your dosbox.cfg conf file. When set to true, its wraps buttons with an upper id than the number of joystick buttons emulated, restarting to 0 (5 will be rewrapped to 0, 6 to 1, etc...) . Set it to false and everything should be fine
+Here are the default Dos (x86)'s controls shown on a [[:configure_a_controller|Batocera Retropad]]:
-===== Windows 3.1 emulation =====
+{{ https://raw.githubusercontent.com/batocera-linux/batocera-controller-overlays/master/solid-4k/dos.png }}
+===== MIDI devices =====
+DOSBox, DOSBox_Staging and libretro: DOSBox_Pure support MIDI devices natively. However, some extra scripting is needed.
+=== Roland UM-ONE USB-Midi Interface ===
+The following script needs to be placed at ''/userdata/system/custom.sh''
+<file custom.sh>
+#!/bin/bash
+modprobe -a snd-seq snd-seq-device snd-seq-midi snd-seq-midi-event
+</file>
+Reboot, and then:
+  * **For DOSBox and DOSBox_Staging**, add ''%%midiconfig = 20:0%%'' or ''%%midiconfig = 24:0%%'' to your configuration file.
+Example settings for 'DOSBOX SVN' by default located in ''/userdata/system/configs/dosbox.conf''
+<file dosbox.conf>
+[midi]
+mididevice = alsa
+midiconfig = 20:0
+mpu401     = intelligent
+</file>
+  * **For libretro: DOSBox_Pure**, in-game navigate to **Settings** -> **Audio** -> **MIDI** and the MIDI device should appear.
+DOSBox-X is unfortunately not compatible with this method.
+===== Troubleshooting =====
+==== Image isn't in the right ratio ====
+For older games, you may have to adjust the ''aspect=false'' parameter to ''aspect=true'' to get the correct 4/3 ratio. Be aware that on newer games this may lead to performance problems
+==== The Joystick is moving by itself ====
+Try modifying ''timed=false'' to ''timed=true''. Can be caused by deadzone too and sadly there is no way to configure deadzone on joystick in DOSBox at the moment
+==== D-pad is not usable on Xbox 360 controller through the mapper ====
+yeah, it is usable in the mapper, but it doesn't seem to work in-game, I know mate :(
+==== Joystick deadzones/my stick is drifting ====
+Sadly it doesn't seem to be possible to adjust deadzones in standard dosbox at the moment.
+==== CD Not Found/CD Driver not present: ====
+you likely forgot to rename cd files with non-dos names (see adv. rundown)
+==== I can get mount a or mount d to work ====
+Contrary to ''imgmount'', ''mount'' is not able to use 'virtual' path from inside the dosbox machine, so for the mount command to work, you need to only use a real local path from the batocera file system. Given that '.' is set to the root/directory when DOSBox is launched you have to specify the full absolute path
+==== The mapper is bugged, it erases my configuration or mix buttons ====
+You're likely victim of the ''buttonwrap'' parameter in your dosbox.cfg conf file. When set to true, its wraps buttons with an upper id than the number of joystick buttons emulated, restarting to 0 (5 will be rewrapped to 0, 6 to 1, etc...) . Set it to false and everything should be fine
+==== I need to exit the game without leaving Dosbox ====
+''[Ctrl]'' + ''[F9]''.
+==== Further troubleshooting ====
+For further troubleshooting, refer to the [[:support|generic support pages]].
-It's also possible to emulate Windows 3.1 games with dosbox, the safest way is to get them from the ExoWin3x collection.\\
-You can also convert them with [[https://github.com/Voljega/ExoDOSConverter|ExoDOSConverter ]]