Compiling Inkscape on Windows with MSYS2

From Inkscape Wiki
Revision as of 16:18, 27 October 2024 by Mgmax (talk | contribs) (Update to WiX4 and UCRT64 according to https://gitlab.com/inkscape/inkscape/-/merge_requests/5900 https://gitlab.com/inkscape/inbox/-/issues/10684 https://gitlab.com/inkscape/inkscape/-/merge_requests/6582)
Jump to navigation Jump to search

This page explains how to compile Inkscape on Windows using MSYS2.

MSYS2 does not only offer a convenient build environment for compiling Inkscape but also provides all necessary build tools and dependencies making it extremely simple to get started with Inkscape development.

Installing MSYS2

To set-up MSYS2 and download the necessary dependencies only two steps are required:

  • Step 1 — Install MSYS2
    1. Download the installer from the MSYS2 homepage (a 64-bit version of Windows 7 or later is required to run MSYS2 and build Inkscape).
      Start the installation and follow the instructions on screen. Use the standard installation directory C:\msys64 .
      Wait until it finishes.
    2. Start an MSYS2 MSYS shell from the start menu (or launch "msys2.exe" in the installation directory).
    3. Execute the command pacman -Syuu. This will start a full system upgrade and ensures that you have the latest versions of all core libraries.
    4. Repeat the previous step until no new updates are found.
  • Step 2 — Download dependencies
    1. Close the MSYS2 MSYS shell.
    2. Read carefully: Start an MSYS2 UCRT64 (!!!) shell from the start menu (or launch "ucrt64.exe" in the installation directory). ⚠️ Warning: Using the right shell type is important so that the right type of Inkscape is built and the right dependencies are installed:
      • UCRT64 is the standard for compiling 64-bit Inkscape
      • (MinGW 64bit / 32bit was used until mid 2023 to build 64/32bit versions. ARM may be used in the future to build for ARM processors.)
      • Never use the "MSYS" shell for compiling Inkscape, only use it for updating MSYS2 itself.
    3. Double-check: The shell window must show "UCRT64" in purple text. If it shows "MSYS" then you have the wrong shell, please go back.
    4. Execute the command curl https://gitlab.com/inkscape/inkscape/-/raw/master/buildtools/msys2installdeps.sh | bash
      (The command downloads and runs the script msys2installdeps.sh. Alternatively, you can copy-paste the script into the console or download it, change to the folder containing the file and type ./msys2installdeps.sh. If you already have a copy of the Inkscape source it should also be included in the "buildtools" folder.)
    5. Relax and take a break, as this may take some time (a few minutes at best, but it can take significantly longer if you have a slow internet connection or the server load is high).

Obtaining Inkscape Source

Note: For general instructions on how to use Git see Working with Git.

As MSYS2 provides the revision control software Git you do not need to download it separately. Simply open the MSYS2 MinGW shell and run the command 

git clone --recurse-submodules https://gitlab.com/inkscape/inkscape.git master

This creates a folder called "master" in the current working directory (usually the home folder located at "C:\msys64\home\Your_Username" or similar) in which the clone of the source repository is created.

You can later update it with: 

git pull --recurse-submodules

Building Inkscape with MSYS2

To compile Inkscape open the MSYS2 UCRT64 shell -- the same as you used above in Step 2 to install the dependencies.

Double-check: The shell window must show "UCRT64" in purple text. If it shows "MSYS" then you have the wrong shell.

Then execute the following commands: 

# change to the directory containing your Inkscape source checkout (has to be
# adjusted to match your system)
cd master

# create a directory for the build (could also be another folder, but we'll
# assume 'build' being used for the rest of the article)
mkdir build
cd build

# create build files with CMake (we generate rules for "Ninja" as it's
# significantly faster then "MinGW Makefiles" which uses mingw32-make)
# note the source path '..' (which in this case is the parent directory) and
# should always point to the root folder of your copy of the Inkscape source
cmake -G Ninja ..

# start the compilation
ninja

# install compiled files and all dependencies required to run Inkscape into the
# folder 'build/inkscape/'
ninja install

# The last two steps can be combined (i.e. run 'ninja install' immediately) to
# save some time (the "install" target includes the default target)

That's it!
Afterwards you should have a complete binary distribution of Inkscape in the folder "build/inkscape/" that can be run on any machine running Windows 7 or later.

Packaging

If you only want to run Inkscape you do not need to follow these instructions. Simply execute inkscape.exe from the "build/inkscape/bin" directory (not "build/bin") created in the previous step, the ninja install command takes care of copying all required files into this directory.

To package those files for distribution (this should only concern package maintainers or people who want to improve the installer code) we offer a set of CMake convenience targets that can be executed as follows:

  • ninja dist-win-7z – generate binary 7z archive. You'll need to install 7-Zip.
  • ninja dist-win-exe – generate .exe installer. You'll need to install Nullsoft Scriptable Install System (NSIS) version 3 or later.
  • ninja dist-win-msi – generate .msi installer.
    • You'll need to install Windows Installer XML (WiX Toolset) version 4 (for Inkscape 1.4.1 and above). To install it:
      • In the start menu, type powershell and click on "Run as Administrator"
      • Open Notepad. Open the file buildtools/windows-deps-install-wix4.ps1 from the Inkscape sources. Select all. Copy.
      • Click in the powershell window with the right mouse button to Paste and run the commands.
    • For older versions up to 1.4.0, you will instead need WiX version 3 from https://github.com/wixtoolset/wix3/releases
  • Additionally there's a dist-win-all target (executes all of the above in parallel).

For some additional details which have not been incorporated into this page yet see the previous instructions at Compiling Inkscape on Windows 32-bit#Creating an installer (might be partially oudated).

Troubleshooting

Issues with MSYS2

The MSYS2 shell does not open.
Try rebooting.
I have trouble updating an existing, older MSYS2 installation
  • Check https://www.msys2.org/news/ for any recent news that may describe your issue and explain how to solve it.
  • The most straightforward solution is often to re-install MSYS2:
  • Uninstall the old MSYS2. Make sure to completely remove the C:\msys64 directory if the uninstaller does not do the job but remember to back up any personal data such as your home folder C:\msys64\home\)
  • Download a fresh installer from https://www.msys2.org/ and start over as described above.

Issues with building Inkscape

The command `ninja` errors out after an MSYS2 update or after pulling new changes from the source reposiotry
Re-run CMake using rm -rf CMakeCache.txt && cmake -G Ninja ...
The first command will delete cached and potentially stale info from the previous run, the second command will run CMake again to update the ninja files.


☎ If you can't solve your issue with the information above, please report a bug or ask in chat.

Retrieved from "https://wiki.inkscape.org/wiki/index.php?title=Compiling_Inkscape_on_Windows_with_MSYS2&oldid=123069"