Note: This is only a one-time setup guide. For actually building KeePassXC, please refer to our build guide.
Setup Visual Studio Environment
We recommend building KeePassXC using Visual Studio to maximize feature availability. Visual Studio is free to use and dependencies are provided from trusted sources or self-built using Vcpkg.
Install Visual Studio
-
Download and install Visual Studio Community 2022: https://visualstudio.microsoft.com/downloads/
-
At a minimum, ensure the following options are selected. We require at least Windows SDK version 10.0.22000.0. You can also import this installation configuration to auto-select these options: keepassxc_vsconfig.zip We recommend you install vcpkg as a component as well. Otherwise you'll have to download and install it manually from https://vcpkg.io/en/getting-started.html.
- (Optional) Instead of the entire IDE, you may install Visual Studio Build Tools and use VSCode as an IDE.
Install Qt6
Qt6 can be built via vcpkg, but that may take hours. For development environments, we recommend you download pre-built Qt binaries from qt.io.
Install Asciidoctor
-
Download and install Ruby without devkit: https://rubyinstaller.org/downloads/
a. Make sure to uncheck install MSYS2/MINGW on the final install screen.
-
Open a command prompt and run: gem install asciidoctor
-
In the same command prompt, test the install by running: asciidoctor
Packaging Requirements
To build an installation package when running make package you need to have the WiX toolset installed. You can obtain it from https://github.com/wixtoolset/wix3/releases
Once installed you will need to add the toolset folder to your MSYS PATH environment: export PATH="${PATH}:/c/Program Files (x86)/WiX Toolset v3.11/bin"