base on DOSBox Staging is a modern continuation of DOSBox with advanced features and current development practices. # DOSBox Staging ![GPL-2.0-or-later][gpl-badge] [![Chat][discord-badge]][discord] **DOSBox Staging** is a modern continuation of DOSBox with advanced features and current development practices. It is a (mostly) drop-in replacement for older DOSBox versions—your existing configurations will continue to work, and you will have access to many advanced features. For a detailed description of the project's scope please refer to the [About](https://www.dosbox-staging.org/about/) page on our website. ## Donations If you enjoy using DOSBox Staging, please [consider a donation](https://www.dosbox-staging.org/get-involved/#make-a-donation) to the project. If you want to help but can't afford a donation, check out the [Get involved](https://www.dosbox-staging.org/get-involved/) page of our website for other ways to contribute. ## Project website https://www.dosbox-staging.org/ First-time users and people migrating from other DOSBox variants should start by reading the [Getting started guide](https://www.dosbox-staging.org/getting-started/). ## Build status [![Windows (VisualStudio) build status][build-win-msvc-badge]][build-win-msvc-ci] [![macOS build status][build-mac-badge]][build-mac-ci] [![Linux x86\_64 build status][build-lin1-badge]][build-lin1-ci] ## Stable release builds Regular users should use our stable release builds available on our project website: - [Windows](https://www.dosbox-staging.org/releases/windows/) - [macOS](https://www.dosbox-staging.org/releases/macos/) - [Linux](https://www.dosbox-staging.org/releases/linux/) ## Development builds Development builds are automatically created on every commit merged to the `main` branch. You need to be logged in to GitHub to download the development builds. [Development builds] ## Key features for developers | **Feature** | **Status** | | -------------------------- | ------------------------------- | | **Version control** | Git | | **Language** | C++20 | | **Logging** | Loguru for C++^[3] | | **Build system** | CMake + Ninja or Visual Studio 2022 | | **Dependency manager** | vcpkg | | **CI** | Yes | | **Static analysis** | Yes^[1],[2] | | **Dynamic analysis** | Yes | | **clang-format** | Yes | | **[Development builds]** | Yes | | **Unit tests** | Yes^[4] | [1]: https://github.com/dosbox-staging/dosbox-staging/actions/workflows/clang-analysis.yml [2]: https://github.com/dosbox-staging/dosbox-staging/actions/workflows/pvs-studio.yml [3]: https://github.com/emilk/loguru [4]: https://github.com/dosbox-staging/dosbox-staging/tree/main/tests [Development builds]: https://www.dosbox-staging.org/releases/development-builds/ ## Source code analysis tools - [PVS-Studio](https://pvs-studio.com/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source) — C++ static analyser - [Pylint](https://pypi.org/project/pylint/) — Python static analyser - [markdownlint](https://github.com/DavidAnson/markdownlint) — style checker and linter for Markdown - [ShellCheck](https://www.shellcheck.net/) — shell script analysis tool ## Dependencies DOSBox Staging has the following library dependencies: | Dependency | Provides feature | vcpkg package name | vcpkg version | Optional? | | --------------------------------------------------------- | ----------------------------------------------- | ------------------ | ----------------- | ------------------- | | [FluidSynth](https://www.fluidsynth.org/) | General MIDI playback | fluidsynth | 2.5.1 | **no** :red_circle: | | [GoogleTest](https://github.com/google/googletest) | Unit testing (development) | gtest | 1.70.0#2 | yes :green_circle: | | [IIR](https://github.com/berndporr/iir1) | Audio filtering | iir1 | 1.10.0 | **no** :red_circle: | | [libmt32emu](https://github.com/munt/munt) | Roland MT-32 and CM-32L emulation | libmt32emu | 2.7.1 | yes :green_circle: | | [libpng](http://www.libpng.org/pub/png/libpng.html) | PNG encoding of screen captures | libpng | 1.6.53 | **no** :red_circle: | | [libslirp](https://gitlab.freedesktop.org/slirp/libslirp) | General purpose TCP-IP emulator | libslirp | 4.9.0 | yes :green_circle: | | [Opus File](https://opus-codec.org/) | CD Audio playback for Opus-encoded audio tracks | opusfile | 0.12+20221121#1 | **no** :red_circle: | | [SDL 2](https://github.com/libsdl-org/SDL) | OS-agnostic API for video, audio, and eventing | sdl2 | 2.32.10 (overlay) | **no** :red_circle: | | [SDL_image 2](https://github.com/libsdl-org/SDL_image) | Image decoding for many popular formats | sdl2-image | 2.8.8#2 | **no** :red_circle: | | [Asio](https://think-async.com/Asio/) | Network API for emulated serial and IPX | asio | 1.30.2 | **no** :red_circle: | | [SpeexDSP](https://github.com/xiph/speexdsp) | Audio resampling | speexdsp | 1.2.1#1 | **no** :red_circle: | | [zlib-ng](https://github.com/zlib-ng/zlib-ng) | ZMBV video capture | zlib-ng | 2.3.2 | yes¹ :green_circle: | _¹ You can use plain old zlib instead._ ### Dynamically loaded dependencies **Slirp** is built separately as a dynamic library (via vcpkg) and is loaded on-demand at runtime if available. Please refer to the [dosbox-staging-ext](https://github.com/dosbox-staging/dosbox-staging-ext) project for further details. To check the version of this dependency included in our stable and dev build packages, check out the comments of the [releases packages](https://github.com/dosbox-staging/dosbox-staging-ext/releases) of the [dosbox-staging-ext](https://github.com/dosbox-staging/dosbox-staging-ext) project. For information on the optional **Nuked SC-55 CLAP** audio plugin, check out the [plugin's GitHub repository](https://github.com/johnnovak/Nuked-SC55-CLAP/) (note Nuked SC-55 CLAP is _not_ a DOSBox Staging project). ## Get the sources Clone the repository (one-time step): ``` shell git clone https://github.com/dosbox-staging/dosbox-staging.git ``` ## Build instructions Please refer to the platform specific build instructions: - [Windows](docs/build-windows.md) - [macOS](docs/build-macos.md) - [Linux](docs/build-linux.md) > **Note** > > CMake support is currently an experimental internal-only, work-in-progress > feature; it's not ready for public consumption yet. Please ignore the > `CMakeLists.txt` files in the source tree. ### Linux, macOS Install build dependencies appropriate for your OS: ``` shell # Fedora sudo dnf install ccache gcc-c++ meson alsa-lib-devel libatomic libpng-devel \ SDL2-devel asio-devel opusfile-devel \ fluidsynth-devel iir1-devel mt32emu-devel libslirp-devel \ speexdsp-devel libXi-devel zlib-ng-devel ``` ``` shell # Debian, Ubuntu sudo apt install ccache build-essential libasound2-dev libatomic1 libpng-dev \ libsdl2-dev libasio-dev libopusfile-dev \ libfluidsynth-dev libslirp-dev libspeexdsp-dev libxi-dev # Install Meson on Debian-11 "Bullseye" or Ubuntu-21.04 and newer sudo apt install meson ``` ``` shell # Arch, Manjaro sudo pacman -S ccache gcc meson alsa-lib libpng sdl2 sdl2_net \ asio opusfile fluidsynth libslirp speexdsp libxi pkgconf ``` ``` shell # openSUSE sudo zypper install ccache gcc gcc-c++ meson alsa-devel libatomic1 libpng-devel \ libSDL2-devel asio-devel \ opusfile-devel fluidsynth-devel libmt32emu-devel libslirp-devel \ speexdsp libXi-devel ``` ``` shell # macOS xcode-select --install brew install cmake ccache meson libpng sdl2 asio opusfile \ fluid-synth libslirp pkg-config python3 speexdsp ``` ### Build and stay up-to-date with the latest sources 1. Check out the main branch: ``` shell # commit or stash any personal code changes git checkout main -f ``` 2. Pull the latest updates. This is necessary every time you want a new build: ``` shell git pull ``` 3. Set up the build. This is a one-time step either after cloning the repo or cleaning your working directories: ``` shell meson setup build ``` The above enables all of DOSBox Staging's functional features. If you're interested in seeing all of Meson's setup options, run `meson configure`. 4. Compile the sources. This is necessary every time you want a new build: ``` shell meson compile -C build ``` Your binary is: `build/dosbox` The binary depends on local resources relative to it, so we suggest symlinking to the binary from your `PATH`, such as into `~/.local/bin/`. ### Windows – Visual Studio (2022 or newer) First, you need to setup [vcpkg] to install build dependencies. Once vcpkg is bootstrapped, open PowerShell and run: ``` powershell PS:\> .\vcpkg integrate install ``` This step will ensure that MSVC can use vcpkg to build, find and links all dependencies. Start Visual Studio and open the file `vs\dosbox.sln`. Make sure you have `x64` selected as the solution platform. Use **Ctrl+Shift+B** to build all projects. Note, the first time you build a configuration, dependencies will be built automatically and stored in the `vcpkg_installed` directory. This can take a significant length of time. [vcpkg]: https://github.com/microsoft/vcpkg ## Imported branches, community patches, old forks Upstream commits are imported to this repo in a timely manner, see branch [`svn/trunk`]. - [`svn/*`] - branches from SVN - [`forks/*`] - code for various abandoned DOSBox forks - [`vogons/*`] - community 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 in the form of [Git notes][git-notes]. To fetch them, run: ``` shell git fetch origin "refs/notes/*:refs/notes/*" ``` ## Website & documentation Please refer to the [documentation guide](DOCUMENTATION.md) before making changes to the website or the documentation. [`svn/*`]: https://github.com/dosbox-staging/dosbox-staging/branches/all?utf8=%E2%9C%93&query=svn%2F [`svn/trunk`]: https://github.com/dosbox-staging/dosbox-staging/tree/svn/trunk [`vogons/*`]: https://github.com/dosbox-staging/dosbox-staging/branches/all?utf8=%E2%9C%93&query=vogons%2F [`forks/*`]: https://github.com/dosbox-staging/dosbox-staging/branches/all?utf8=%E2%9C%93&query=forks%2F [git-notes]: https://git-scm.com/docs/git-notes [gpl-badge]: https://img.shields.io/badge/license-GPL--2.0--or--later-blue [discord-badge]: https://img.shields.io/discord/514567252864008206?color=%237289da&logo=discord&logoColor=white&label=discord [discord]: https://discord.gg/WwAg3Xf [build-lin1-badge]: https://img.shields.io/github/actions/workflow/status/dosbox-staging/dosbox-staging/linux.yml?label=Linux%20%28x86_64%29 [build-lin1-ci]: https://github.com/dosbox-staging/dosbox-staging/actions/workflows/linux.yml?query=branch%3Amain [build-win-msvc-badge]: https://img.shields.io/github/actions/workflow/status/dosbox-staging/dosbox-staging/windows-msvc.yml?label=Windows%20%28Visual%20Studio%29 [build-win-msvc-ci]: https://github.com/dosbox-staging/dosbox-staging/actions/workflows/windows-msvc.yml?query=branch%3Amain [build-mac-badge]: https://img.shields.io/github/actions/workflow/status/dosbox-staging/dosbox-staging/macos.yml?label=macOS%20%28x86_64%2C%20arm64%29 [build-mac-ci]: https://github.com/dosbox-staging/dosbox-staging/actions/workflows/macos.yml?query=branch%3Amain ", Assign "at most 3 tags" to the expected json: {"id":"7892","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"