Skip to content

Latest commit

 

History

History
116 lines (79 loc) · 3.59 KB

build-windows.md

File metadata and controls

116 lines (79 loc) · 3.59 KB

Building on Windows

Windows builds can be created using:

  • Visual Studio 2022 IDE suite with Clang/LLVM compiler, and vcpkg to provide dependencies. This is the fully-supported toolchain used to create release builds.
  • The Clang or GCC compilers using the Meson buildsystem running within the MSYS2 environment to provide dependencies.

Build using Visual Studio

  1. Install Visual Studio Community 2022: https://visualstudio.microsoft.com/vs/community/.

    • Select "C++ Clang tools for Windows" in the Visual Studio installer

  2. Install/configure vcpkg.

    • Recent versions of Visual Studio already include it1, but it needs to be initialized. Open a Visual Studio Developer Command Prompt and run the following command:

      vcpkg integrate install

    • Existing standalone versions should work as well.

  3. Follow instructions in README.md.

Create a Debugger build using Visual Studio

Note that the debugger imposes a significant runtime performance penalty. If you're not planning to use the debugger then the steps above will help you build a binary optimized for gaming.

  1. Edit src\platform\visualc\config.h and enable C_DEBUG and optionally C_HEAVY_DEBUG by setting them to 1 instead of 0.

  2. Select a Release build type in Visual Studio, and run the build.

Build using MSYS2

  1. Install MSYS2: https://www.msys2.org/wiki/MSYS2-installation/

  2. Install Git: pacman -S git

  3. Clone and enter the repository's directory:

    git clone https://github.com/dosbox-staging/dosbox-staging.git
cd dosbox-staging

  4. Update the pacman database and packages:

    • Open an MSYS2 console from your start menu.
    • Run pacman -Syu, answer Y, and let it run to completion.
    • Close your terminal when it's done.
    • Re-open the terminal and repeat the process one last time: Run pacman -Syu, answer Y, and let it run to completion.

  5. Install the GCC and Clang runtime groups:

    Note: this will uninstall non-MinGW compilers followed by installing the GCC and Clang runtime groups along with Staging's dependencies.

    cd dosbox-staging
pacman -R clang
pacman -R gcc
pacman -S $(cat packages/windows-msys2-clang-x86_64.txt packages/windows-msys2-gcc-x86_64.txt)

    Close your terminal when this finishes.

  6. Open a toolchain-specific MinGW terminal:

    • GCC: Start Menu > Programs > MSYS2 > MSYS2 MinGW x64
    • Clang: Start Menu > Programs > MSYS2 > MSYS2 MinGW Clang x64

    You can then use those specific toolchains within the respecitive terminal.

  7. Setup a GCC build from an MSYS2 MinGW x64 terminal:

    meson setup build/release-gcc

  8. Setup a Clang build from an MSYS2 MinGW Clang x64 terminal:

    meson setup build/release-clang --native-file=.github/meson/native-clang.ini

    If building for Vista use instead:

    meson setup -Duse_fluidsynth=false -Duse_slirp=false build/release-clang --native-file=.github/meson/native-clang.ini

  9. Compile:

    meson compile -C build/release-gcc
# or
meson compile -C build/release-clang

  10. Create a package of the binary and DLLs to a destination directory:

./scripts/create-package.sh -p msys2 build/release-gcc ../dosbox-staging-gcc-pkg
# or
./scripts/create-package.sh -p msys2 build/release-clang ../dosbox-staging-clang-pkg

Footnotes

  1. https://devblogs.microsoft.com/cppblog/vcpkg-is-now-included-with-visual-studio/. ↩