dosbox-staging

This repository attempts to modernize the DOSBox project by using current development practices and tools, fixing issues, adding features that better support today's systems, and sending patches upstream. Read more at Vogons thread.

Summary of differences compared to upstream:

	dosbox-staging	DOSBox
Version control	Git	SVN
Language	C++11	C++031
CI	Yes	No
Static analysis	Yes2,3	No
Dynamic analysis	Yes	No
Automated regression tests	No (planned)4	No
SDL	2.0	1.2＊

dosbox-staging does not support audio playback using physical CDs. Using CD Digital Audio emulation (loading CD music via cue sheets or mounting ISO images) is preferred instead.

Codecs supported for CD-DA emulation:

	dosbox-staging†	DOSBox‡
Opus	Yes (libopus)	No
OGG/Vorbis	Yes (built-in)	Yes - SDL_sound 1.2 (libvorbis)5,＊
MP3	Yes (built-in)	Yes - SDL_sound 1.2 (libmpg123)5,＊,§
FLAC	Yes (built-in)	No§
WAV	Yes (built-in)	Yes - SDL_sound 1.2 (internal)6,＊
AIFF	No	Yes - SDL_sound 1.2 (internal)6,＊

^{＊ - SDL 1.2 is not actively maintained any more.
† - 22.05 kHz, 44.1 kHz, 48 kHz; mono, stereo
‡ - 44.1 kHz stereo only
§ - SDL_sound supports it, but the feature might be broken or DOSBox does not indicate support.}

Development snapshot builds

Pre-release builds can be downloaded from CI build artifacts. Go to Linux or Windows, select a build you are interested in, click "Artifacts" button (in the top right), and download the package.

Linux

Snapshots are dynamically-linked x86_64 builds, you'll need additional packages installed via your package manager.

Fedora

$ sudo dnf install libpng SDL2 SDL2_net opusfile

Debian, Ubuntu

$ sudo apt install libpng16-16 libsdl2-2.0 libsdl2-net-2.0 libopusfile0

Arch, Manjaro

$  sudo pacman -S libpng sdl2 sdl2_net opusfile

Windows

A dosbox.exe file in a snapshot package is not signed, therefore Windows 10 might prevent the program from starting.

If Windows displays the message "Windows Defender SmartScreen prevented an unrecognised app from starting", you have two options to dismiss it:

1. Click "More info", and button "Run anyway" will appear.
2. Right-click on dosbox.exe, select: Properties → General → Security → Unblock

Windows packages are built for "x86" architecture (in practice it means i686).

macOS

macOS snapshots are not available at the moment.

Build instructions

Linux, macOS, MSYS2, MinGW, other OSes

Read INSTALL file for a general summary about dependencies and configure options. Read build.md for the comprehensive compilation guide.

$ git clone https://github.com/dreamer/dosbox-staging.git
$ cd dosbox-staging
$ ./autogen.sh
$ ./configure
$ make

You can also use a helper script ./scripts/build.sh, that performs builds for many useful scenarios (LTO, FDO, sanitizer builds, many others).

Visual Studio (2019 or newer)

First, you need to setup vcpkg to install build dependencies. Once vcpkg is installed and bootstrapped, open PowerShell, and run:

PS> .\vcpkg integrate install
PS> .\vcpkg install libpng sdl2 sdl2-net opusfile

These two steps will ensure that MSVC finds and links all dependencies.

Start Visual Studio, open file: vs\dosbox.sln and build all projects (Ctrl+Shift+B).

Interop with SVN

This repository is (deliberately) NOT git-svn compatible, this is a pure Git repo.

Commits landing in SVN upstream are imported to this repo in a timely manner, to the branches matching svn/* pattern. You can safely use those branches to rebase your changes, and prepare patches using Git format-patch for sending upstream (it is easier and faster, than preparing patches manually).

Other branch name patterns are also in use, e.g. vogons/* for various patches posted on the Vogons forum.

Git tags matching pattern svn/* are pointing to the commits referenced by SVN "tag" paths at the time of creation.

Additionally, we attach some optional metadata to the commits imported from SVN in the form of Git notes. To fetch them, run:

$ git fetch origin "refs/notes/*:refs/notes/*"