joncampbell123/dosbox-x
1
0
Fork 0
mirror of https://github.com/joncampbell123/dosbox-x.git synced 2025-10-14 02:17:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
Wengier
2021-07-01 16:50:27 -04:00
parent 0605e1c0f9
commit ecd59e12be
4 changed files with 31 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
INSTALL.md
View File

@@ -3,9 +3,9 @@ DOSBox-X Installation and Released Packages
DOSBox-X is a cross-platform DOS emulator based on DOSBox, with the eventual goal of being a complete DOS emulation package. New versions of DOSBox-X are released periodically, typically on the last day of a month or the first day of the next month. Since DOSBox-X is cross-platform, all major host operating systems are officially supported including Windows (XP or later), Linux (with X11), macOS (10.12 or later) and DOS operating systems.
The current version of DOSBox-X at this time is DOSBox-X 0.83.14, which was released on June 1, 2021. Pre-compiled Windows binaries (both 32-bit and 64-bit), Linux Flatpak and RPM packages (64-bit), macOS packages (64-bit) and the special HX-DOS packages (for real DOS environments) are officially available, as well as the Windows installers and source code packages. You will find DOSBox-X versions that have been released so far (ZIP or RPM packages) and change logs for these versions in the [Releases](https://github.com/joncampbell123/dosbox-x/releases) page.
The current version of DOSBox-X at this time is DOSBox-X 0.83.15, which was released on July 1, 2021. Pre-compiled Windows binaries (both 32-bit and 64-bit), Linux Flatpak and RPM packages (64-bit), macOS packages (64-bit) and the special HX-DOS packages (for real DOS environments) are officially available, as well as the Windows installers and source code packages. You will find DOSBox-X versions that have been released so far (ZIP or RPM packages) and change logs for these versions in the [Releases](https://github.com/joncampbell123/dosbox-x/releases) page.
See also: [DOSBox-X 0.83.14 Release Notes](https://dosbox-x.com/release-0.83.14.html)
See also: [DOSBox-X 0.83.15 Release Notes](https://dosbox-x.com/release-0.83.15.html)
Once you get DOSBox-X installed and running, you probably want to look at the DOSBox-X user guide in the [DOSBox-X Wiki](https://dosbox-x.com/wiki) for usage information.
@@ -19,27 +19,29 @@ Once you get DOSBox-X installed and running, you probably want to look at the DO
## Windows Packages (Installer or Portable)
You probably want to use the all-in-one Windows installation packages for the ease of installation, which are especially recommended for new and non-expert users. With the installer the installation process will be automated while allowing you to change the install folder and the default build to run if you prefer (and the option to install all builds to subdirectories), so that you will be able to start DOSBox-X as soon as the installation ends. A quick start guide is also included in the package, and shell context menus can be automatically added for a fast launch of DOSBox-X from the Windows Explorer. The Windows installers for the current DOSBox-X version 0.83.14 are available from:
(Coming soon for DOSBox-X 0.83.15 installer)
* [dosbox-x-windows-0.83.14-setup.exe](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-windows-0.83.14-setup.exe) (Standard install mode; Windows XP or later)
You probably want to use the all-in-one Windows installation packages for the ease of installation, which are especially recommended for new and non-expert users. With the installer the installation process will be automated while allowing you to change the install folder and the default build to run if you prefer (and the option to install all builds to subdirectories), so that you will be able to start DOSBox-X as soon as the installation ends. A quick start guide is also included in the package, and shell context menus can be automatically added for a fast launch of DOSBox-X from the Windows Explorer. The Windows installers for the current DOSBox-X version 0.83.15 are available from:
* [dosbox-x-windows-0.83.14-setup-allusers.exe](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-windows-0.83.14-setup-allusers.exe) (Administrative install mode; Windows Vista or later)
* [dosbox-x-windows-0.83.15-setup.exe](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.15/dosbox-x-windows-0.83.15-setup.exe) (Standard install mode; Windows XP or later)
* [dosbox-x-windows-0.83.15-setup-allusers.exe](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.15/dosbox-x-windows-0.83.15-setup-allusers.exe) (Administrative install mode; Windows Vista or later)
Windows installers for the previous DOSBox-X versions are also available from:
* [dosbox-x-windows-0.83.14-setup.exe](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-windows-0.83.14-setup.exe) (version 0.83.14)
* [dosbox-x-windows-0.83.13-setup.exe](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.13/dosbox-x-windows-0.83.13-setup.exe) (version 0.83.13)
* [dosbox-x-windows-0.83.12-setup.exe](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.12/dosbox-x-windows-0.83.12-setup.exe) (version 0.83.12)
If you see the message ```Windows Defender SmartScreen prevented an unrecognized app from starting```, you can solve it by clicking the link "More info" in the dialog and then "Run anyway".
You can easily upgrade from a previous version of DOSBox-X to the new version with the Windows installer. The Windows installer in fact offers an option to automatically upgrade the config file (dosbox-x.conf) to the new version format while keeping all the user-customized settings already made. When you select this (recommended), the config file will include all options of the latest DOSBox-X version and also will keep all the changes already done previously by the user.
Apart from the Windows installers, you can find six zip packages (three before 0.83.13) for each DOSBox-X version for the Windows platform in the [Releases](https://github.com/joncampbell123/dosbox-x/releases) page as an alternative way to install DOSBox-X. These zip files are portable packages containing binaries built with Visual Studio 2019 (Win32, Win64, ARM32, ARM64 respectively), MinGW (Win32 and Win64 respectively). For the current DOSBox-X version 0.83.14, these portable builds are separately available from:
Apart from the Windows installers, you can find six zip packages (three before 0.83.13) for each DOSBox-X version for the Windows platform in the [Releases](https://github.com/joncampbell123/dosbox-x/releases) page as an alternative way to install DOSBox-X. These zip files are portable packages containing binaries built with Visual Studio 2019 (Win32, Win64, ARM32, ARM64 respectively), MinGW (Win32 and Win64 respectively). For the current DOSBox-X version 0.83.15, these portable builds are separately available from:
* [dosbox-x-vsbuild-win32-20210601022229.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-vsbuild-win32-20210601022229.zip) (Visual Studio Win32 builds)
* [dosbox-x-vsbuild-win64-20210601022229.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-vsbuild-win64-20210601022229.zip) (Visual Studio Win64 builds)
* [dosbox-x-vsbuild-arm32-20210601022229.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-vsbuild-arm32-20210601022229.zip) (Visual Studio ARM32 builds)
* [dosbox-x-vsbuild-arm64-20210601022229.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-vsbuild-arm64-20210601022229.zip) (Visual Studio ARM64 builds)
* [dosbox-x-vsbuild-win32-20210701083944.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.15/dosbox-x-vsbuild-win32-20210701083944.zip) (Visual Studio Win32 builds)
* [osbox-x-vsbuild-win64-20210701083944.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.15/dosbox-x-vsbuild-win64-20210701083944.zip) (Visual Studio Win64 builds)
* [dosbox-x-vsbuild-arm32-20210701083944.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.15/dosbox-x-vsbuild-arm32-20210701083944.zip) (Visual Studio ARM32 builds)
* [dosbox-x-vsbuild-win64-20210701083944.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.15/dosbox-x-vsbuild-win64-20210701083944.zip) (Visual Studio ARM64 builds)
* [dosbox-x-mingw-win32-20210601022419.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-mingw-win32-20210601022419.zip) (MinGW Win32 builds)
* [dosbox-x-mingw-win64-20210601074604.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-mingw-win64-20210601074604.zip) (MinGW Win64 builds)
@@ -49,9 +51,11 @@ If you prefer to use one of the portable packages, please select the zip package
## Linux Packages (Flatpak or RPM)
(Linux packages for version 0.83.15 coming soon)
Both Flatpak and RPM packages are officially released for the Linux operating system (with X11). You can select one of these packages depending on your Linux system and your needs. The Linux Fatpak package has the advantage of being supported by most or all Linux distributions, but it will run in a sandbox on your Linux system so that you may not able to access some system-wide resources.
Flatpak packages are standalone applications independent of Linux distributions. For the current DOSBox-X version 0.83.14 the Linux Flatpak is available from:
Flatpak packages are standalone applications independent of Linux distributions. For the current DOSBox-X version 0.83.1 the Linux Flatpak is available from:
* [com.dosbox_x.DOSBox-X.flatpakref](https://dl.flathub.org/repo/appstream/com.dosbox_x.DOSBox-X.flatpakref)
@@ -93,13 +97,13 @@ Moreover, you can find DOSBox-X on SnapCraft (https://snapcraft.io/dosbox-x), wh
## macOS Packages (Portable)
If you use macOS as your operating system, we also release portable packages for the macOS (64-bit) platform. For the current DOSBox-X version 0.83.14, the official macOS packages are available as zip packages:
If you use macOS as your operating system, we also release portable packages for the macOS (64-bit) platform. For the current DOSBox-X version 0.83.15, the official macOS packages are available as zip packages:
For 64-bit Intel-based macOS:
* [dosbox-x-macosx-x86_64-20210531184050.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-macosx-x86_64-20210531184050.zip)
* [dosbox-x-macosx-x86_64-20210701081053.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.15/dosbox-x-macosx-x86_64-20210701081053.zip)
For 64-bit ARM-based macOS:
* [dosbox-x-macosx-arm64-20210531191420.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-macosx-arm64-20210531191420.zip)
* [dosbox-x-macosx-arm64-20210701081059.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.15/dosbox-x-macosx-arm64-20210701081059.zip)
The macOS package requires 64-bit Intel or ARM-based macOS operating system. It should run natively on the recent versions of macOS such as macOS Catalina (10.15) and Big Sur (11.0). Both SDL1 and SDL2 binaries (in .app format) are provided in the macOS package, in the directories named ```dosbox-x``` and ```dosbox-x-sdl2``` respectively inside the zip file. While the SDL1 version is the default version, the SDL2 version may be preferred over the SDL1 version for certain features (particularly related to input handling) such as touchscreen input support. You can select either SDL1 or SDL2 version according to your preference, or just run the SDL1 version if you are not sure.
@@ -113,7 +117,7 @@ If you see the message ```"dosbox-x" is damaged and can't be opened``` when tryi
``xattr -cr dosbox-x/dosbox-x.app dosbox-x-sdl2/dosbox-x.app``
As of DOSBox-X version 0.83.14, the macOS SDL2 build supports the Slirp and FluidSynth features by default, but you need to make sure both libraries are already installed in your macOS system in order to run this build. You can install them via [brew](https://brew.sh/) with the following commands (you only need to do this once):
As of DOSBox-X version 0.83.15, macOS packages support the Slirp and FluidSynth features by default, but you need to make sure both libraries are already installed in your macOS system in order to run this build. You can install them via [brew](https://brew.sh/) with the following commands (you only need to do this once):
```
brew fluid-synth
@@ -134,9 +138,9 @@ macOS versions earlier than 10.12 (Sierra) are not officially supported. If you
Besides Windows, Linux and macOS packages, there are also packages released for the DOS operating system. Yes, DOSBox-X can officially run on DOS systems as well, as some DOS users seem to prefer to run DOS applications and games through a DOS emulator. With DOSBox-X running in DOS you are able to emulate another DOS system with a different PC configuration (such as different machine types, video and sound cards etc) that works better for the purpose of the users. But please note that due to the limitations of this environment not all features of DOSBox-X that are available in other platforms can be supported in the DOS version.
For the current DOSBox-X version 0.83.14, the official DOS version is available in the following zip package:
For the current DOSBox-X version 0.83.15, the official DOS version is available in the following zip package:
* [dosbox-x-mingw-hx-dos-20210601013916.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.14/dosbox-x-mingw-hx-dos-20210601013916.zip)
* [dosbox-x-mingw-hx-dos-20210701082051.zip](https://github.com/joncampbell123/dosbox-x/releases/download/dosbox-x-v0.83.15/dosbox-x-mingw-hx-dos-20210701082051.zip)
The HX-DOS package allows you to run DOSBox-X in a real DOS system (MS-DOS 5.0+ or compatible) with the help of the freely-available [HX DOS Extender](https://github.com/Baron-von-Riedesel/HX), which is already included in the recent DOS release packages. Once you unzip the package you can directly type ```DOSBOX-X``` to run in DOS. See the README.TXT file inside the DOS package for more information.
@@ -150,11 +154,11 @@ Note: You may not see DOS packages for some DOSBox-X versions. For example, the
## Source Code Packages (zip or tar.gz)
Full source code packages of DOSBox-X are also available in both zip and tar.gz formats. Both contain the full source code, but you probably want to download the source code in zip format if you are using Windows, and the source code in tar.gz format if you are using Linux. For the current DOSBox-X version 0.83.14, the source code packages are:
Full source code packages of DOSBox-X are also available in both zip and tar.gz formats. Both contain the full source code, but you probably want to download the source code in zip format if you are using Windows, and the source code in tar.gz format if you are using Linux. For the current DOSBox-X version 0.83.15, the source code packages are:
* [dosbox-x-v0.83.14.zip](https://github.com/joncampbell123/dosbox-x/archive/refs/tags/dosbox-x-v0.83.14.zip)
* [dosbox-x-v0.83.14.tar.gz](https://github.com/joncampbell123/dosbox-x/archive/refs/tags/dosbox-x-v0.83.14.tar.gz)
* [dosbox-x-v0.83.15.zip](https://github.com/joncampbell123/dosbox-x/archive/refs/tags/dosbox-x-v0.83.15.zip)
* [dosbox-x-v0.83.15.tar.gz](https://github.com/joncampbell123/dosbox-x/archive/refs/tags/dosbox-x-v0.83.15.tar.gz)
If you prefer you can compile DOSBox-X from the source code by yourself. The source code packages as listed in the [Releases](https://github.com/joncampbell123/dosbox-x/releases) page contain the source code for that released version, and in this example the current DOSBox-X 0.83.14 version. On the other hand, if you are looking for the latest source code of DOSBox-X (including the most recent development changes in the source code), you may want to use the source code in the repository instead, or you can browse the latest source code using [Doxygen](https://dosbox-x.com/doxygen/html/index.html).
If you prefer you can compile DOSBox-X from the source code by yourself. The source code packages as listed in the [Releases](https://github.com/joncampbell123/dosbox-x/releases) page contain the source code for that released version, and in this example the current DOSBox-X 0.83.15 version. On the other hand, if you are looking for the latest source code of DOSBox-X (including the most recent development changes in the source code), you may want to use the source code in the repository instead, or you can browse the latest source code using [Doxygen](https://dosbox-x.com/doxygen/html/index.html).
You could use either the released source code package or the latest source code according to your needs, and the source code may be compiled to run on the above-mentioned platforms (Windows, Linux, macOS and DOS) and possibly other operating systems too. Please see the [BUILD](BUILD.md) page for detailed instructions on building the DOSBox-X source code. Further descriptions of the source code can be found in the [DOSBox-X source code description](README.source-code-description) file.