Compiling Inkscape on Windows with MSYS2 - Revision history

Mgmax: Moved to GitLab

2025-05-31T12:49:55Z

Moved to GitLab

Mgmax: page is being moved to GitLab - add warning

2025-05-27T19:05:35Z

page is being moved to GitLab - add warning

← Older revision		Revision as of 19:05, 27 May 2025
Line 1:		Line 1:
			'''<big>Under construction: This page is being moved to GitLab. Please do not make new edits.</big>'''


	This page explains how to compile Inkscape on Windows using [http://www.msys2.org/ '''MSYS2'''].		This page explains how to compile Inkscape on Windows using [http://www.msys2.org/ '''MSYS2'''].

Mgmax: remove "work-in-progress" marker

2024-12-17T16:26:50Z

remove "work-in-progress" marker

← Older revision		Revision as of 16:26, 17 December 2024
Line 4:		Line 4:

	== Installing Build Dependencies Easily ==		== Installing Build Dependencies Easily ==

	~~Work in progress, see https://gitlab.com/inkscape/inkscape/-/merge_requests/6573 - Until 2024-12-19, please see below "Installing Build Dependencies manually".~~

	In the basic case, you can install all the needed tools with a one-click script. This is supported for Inkscape 1.5 or newer, running on standard 64bit Windows (not ARM). In other cases, please see below "Installing Build Dependencies Manually".		In the basic case, you can install all the needed tools with a one-click script. This is supported for Inkscape 1.5 or newer, running on standard 64bit Windows (not ARM). In other cases, please see below "Installing Build Dependencies Manually".

Mgmax: fix link

2024-12-17T15:06:19Z

fix link

← Older revision		Revision as of 15:06, 17 December 2024
Line 10:		Line 10:

	# Get the buildtools folder from the Inkscape git repository. One way to do this is the following:		# Get the buildtools folder from the Inkscape git repository. One way to do this is the following:
	#* Download the following ZIP ~~<nowiki>~~https://gitlab.com/inkscape/inkscape/-/archive/master/inkscape-master.zip?path=buildtools~~</nowiki>~~		#* Download the following ZIP https://gitlab.com/inkscape/inkscape/-/archive/master/inkscape-master.zip?path=buildtools
	#* Unpack it		#* Unpack it
	# Double-click on <code>windows-deps-clickHere.bat</code>		# Double-click on <code>windows-deps-clickHere.bat</code>

Mgmax: Explain simple script to install build dependencies https://gitlab.com/inkscape/inkscape/-/merge_requests/6573

2024-12-17T15:05:29Z

Explain simple script to install build dependencies https://gitlab.com/inkscape/inkscape/-/merge_requests/6573

Show changes

Mgmax: try again to fix linebreaks. damn.

2024-10-27T16:23:04Z

try again to fix linebreaks. damn.

← Older revision		Revision as of 16:23, 27 October 2024
Line 13:		Line 13:
	* '''Step 2''' — Download dependencies		* '''Step 2''' — Download dependencies
	*# Close the MSYS2 '''MSYS''' shell.		*# Close the MSYS2 '''MSYS''' shell.
	*#'''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:		*#'''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		# 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.)		# (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.		# '''Never''' use the "MSYS" shell for compiling Inkscape, only use it for updating MSYS2 itself.
	*#'''Double-check:''' The shell window must show "'''UCRT64'''" in purple text. If it shows "MSYS" then you have the wrong shell, please go back.		*#'''Double-check:''' The shell window must show "'''UCRT64'''" in purple text. If it shows "MSYS" then you have the wrong shell, please go back.
	*# Execute the command <code>curl https://gitlab.com/inkscape/inkscape/-/raw/master/buildtools/msys2installdeps.sh \| bash</code><br />(The command downloads and runs the script [https://gitlab.com/inkscape/inkscape/blob/master/buildtools/msys2installdeps.sh msys2installdeps.sh]. Alternatively, you can copy-paste the script into the console or download it, change to the folder containing the file and type <code>./msys2installdeps.sh</code>. If you already have a copy of the Inkscape source it should also be included in the "buildtools" folder.)		*# Execute the command <code>curl https://gitlab.com/inkscape/inkscape/-/raw/master/buildtools/msys2installdeps.sh \| bash</code><br />(The command downloads and runs the script [https://gitlab.com/inkscape/inkscape/blob/master/buildtools/msys2installdeps.sh msys2installdeps.sh]. Alternatively, you can copy-paste the script into the console or download it, change to the folder containing the file and type <code>./msys2installdeps.sh</code>. If you already have a copy of the Inkscape source it should also be included in the "buildtools" folder.)

Mgmax: Fix linebreaks

2024-10-27T16:21:27Z

Fix linebreaks

← Older revision		Revision as of 16:21, 27 October 2024
Line 94:		Line 94:
	; The MSYS2 shell does not open.		; The MSYS2 shell does not open.
	: Try rebooting.		: Try rebooting.
	; I have trouble updating an existing, older MSYS2 installation		'''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:		* Check <nowiki>https://www.msys2.org/news/</nowiki> for any recent news that may describe your issue and explain how to solve it.
	::* Uninstall the old MSYS2. Make sure to completely remove the ~~<code>~~C:\msys64~~</code>~~ directory if the uninstaller does not do the job ~~'''~~but~~'''~~ remember to back up any personal data such as your home folder ~~<code>~~C:\msys64\home\~~</code>~~)		* The most straightforward solution is often to re-install MSYS2:
	::* Download a fresh installer from https://www.msys2.org/ and start over as described above.		** 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 <nowiki>https://www.msys2.org/</nowiki> and start over as described above.

	=== Issues with building Inkscape ===		=== Issues with building Inkscape ===

	; The command `ninja` errors out after an MSYS2 update or after pulling new changes from the source reposiotry		; The command `ninja` errors out after an MSYS2 update or after pulling new changes from the source reposiotry
	: Re-run CMake using <code>rm -rf CMakeCache.txt && cmake -G Ninja ..</code>.		: Re-run CMake using <code>rm -rf CMakeCache.txt && cmake -G Ninja ..</code>.

Mgmax: 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

2024-10-27T16:18:21Z

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

← Older revision		Revision as of 16:18, 27 October 2024
Line 4:		Line 4:

	== Installing MSYS2 ==		== Installing MSYS2 ==

	~~[[File:MSYS2 shells.png\|541x541px\|thumb\|~~
	~~<div>Always use the proper shell~~
	~~<ul>~~
	~~<li>"MinGW 32-bit" for compiling 32-bit Inkscape</li>~~
	~~<li>"MinGW 64-bit" for compiling 64-bit Inkscape</li>~~
	~~<li>'''Never''' use the "MSYS" shell for compiling Inkscape, only use it for updating MSYS2 itself.</li>~~
	~~</ul>~~
	~~<br/>~~
	~~You can identify the different shells according to the the purple text string in the console window (<tt>MINGW32</tt>, <tt>MINGW64</tt> or <tt>MSYS</tt> respectively).~~
	~~</div>]]~~

	To set-up MSYS2 and download the necessary dependencies only two steps are required:		To set-up MSYS2 and download the necessary dependencies only two steps are required:
	* '''Step 1''' — Install MSYS2		* '''Step 1''' — Install MSYS2
	*# Download the installer from the [http://www.msys2.org/ MSYS2 homepage] (a 64-bit version of Windows 7 or later is required to run MSYS2 and build Inkscape).<br />Start the installation and follow the instructions on screen. Wait until it finishes.		*# Download the installer from the [http://www.msys2.org/ MSYS2 homepage] (a 64-bit version of Windows 7 or later is required to run MSYS2 and build Inkscape).<br />Start the installation and follow the instructions on screen. Use the standard installation directory <code>C:\msys64</code> .<br />Wait until it finishes.
	*# Start an MSYS2 '''MSYS''' shell ~~(Do not use the one launched by the installer! use the "MSYS2 MSYS" shortcut in~~ the start menu or launch "msys2.exe" in the installation directory).		*# Start an MSYS2 '''MSYS''' shell from the start menu (or launch "msys2.exe" in the installation directory).
	*#Execute the command <code>pacman -Syuu</code>. This will start a full system upgrade and ensures that you have the latest versions of all core libraries.		*#Execute the command <code>pacman -Syuu</code>. This will start a full system upgrade and ensures that you have the latest versions of all core libraries.
	*# Repeat the previous step until no new updates are found.		*# Repeat the previous step until no new updates are found.
	* '''Step 2''' — Download dependencies		* '''Step 2''' — Download dependencies
	*# Start an MSYS2 '''~~MinGW~~''' shell ~~(use the "MSYS2 MinGW 32/64-bit" shortcut in~~ the start menu or launch "~~mingw32/64~~.exe" in the installation directory).~~<br />Choose~~ the shell ~~in this step (32-bit or~~ 64-bit~~) according~~ to ~~whether you want~~ to build ~~a 32-bit or 64-bit version of~~ Inkscape ~~later~~. 64-~~bit is recommended~~.		*# Close the MSYS2 '''MSYS''' shell.
			*#'''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.
			*#'''Double-check:''' The shell window must show "'''UCRT64'''" in purple text. If it shows "MSYS" then you have the wrong shell, please go back.
	*# Execute the command <code>curl https://gitlab.com/inkscape/inkscape/-/raw/master/buildtools/msys2installdeps.sh \| bash</code><br />(The command downloads and runs the script [https://gitlab.com/inkscape/inkscape/blob/master/buildtools/msys2installdeps.sh msys2installdeps.sh]. Alternatively, you can copy-paste the script into the console or download it, change to the folder containing the file and type <code>./msys2installdeps.sh</code>. If you already have a copy of the Inkscape source it should also be included in the "buildtools" folder.)		*# Execute the command <code>curl https://gitlab.com/inkscape/inkscape/-/raw/master/buildtools/msys2installdeps.sh \| bash</code><br />(The command downloads and runs the script [https://gitlab.com/inkscape/inkscape/blob/master/buildtools/msys2installdeps.sh msys2installdeps.sh]. Alternatively, you can copy-paste the script into the console or download it, change to the folder containing the file and type <code>./msys2installdeps.sh</code>. If you already have a copy of the Inkscape source it should also be included in the "buildtools" folder.)
	*# 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).		*# 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).

	~~⚠️ ''Warning: Always make sure to use the proper MSYS2 shell (see screenshot to the right). Dependencies are separate for 32-bit and 64-bit Inkscape.''~~

	~~<br clear=all>~~

	== Obtaining Inkscape Source ==		== Obtaining Inkscape Source ==
Line 46:		Line 36:
	== Building Inkscape with MSYS2 ==		== Building Inkscape with MSYS2 ==

	To compile Inkscape open the MSYS2 ~~MinGW~~ shell ~~(remember to use the correct shell, i.e. 32~~-~~bit or 64~~-~~bit, matching~~ the ~~dependencies~~ you ~~downloaded~~ above ~~and~~ the ~~version of Inkscape~~ you ~~want to build)~~.		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:		Then execute the following commands:
Line 86:		Line 78:
	* <code>ninja dist-win-7z</code> – generate binary 7z archive. You'll need to install [http://www.7-zip.org/ 7-Zip].		* <code>ninja dist-win-7z</code> – generate binary 7z archive. You'll need to install [http://www.7-zip.org/ 7-Zip].
	* <code>ninja dist-win-exe</code> – generate .exe installer. You'll need to install [http://nsis.sourceforge.net/ Nullsoft Scriptable Install System (NSIS)] version 3 or later.		* <code>ninja dist-win-exe</code> – generate .exe installer. You'll need to install [http://nsis.sourceforge.net/ Nullsoft Scriptable Install System (NSIS)] version 3 or later.
	* <code>ninja dist-win-msi</code> – generate .msi installer. You'll need to install [http://wixtoolset.org/ Windows Installer XML (WiX Toolset)].		* <code>ninja dist-win-msi</code> – generate .msi installer.
			**You'll need to install [http://wixtoolset.org/ Windows Installer XML (WiX Toolset)] version 4 (for Inkscape 1.4.1 and above). To install it:
			***In the start menu, type <code>powershell</code> 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 <code>dist-win-all</code> target (executes all of the above in parallel).		* Additionally there's a <code>dist-win-all</code> target (executes all of the above in parallel).

Line 107:		Line 104:
	; The command `ninja` errors out after an MSYS2 update or after pulling new changes from the source reposiotry		; The command `ninja` errors out after an MSYS2 update or after pulling new changes from the source reposiotry
	: Re-run CMake using <code>rm -rf CMakeCache.txt && cmake -G Ninja ..</code>.		: Re-run CMake using <code>rm -rf CMakeCache.txt && cmake -G Ninja ..</code>.
	: The first command will delete cached and potentially stale info from the previous run, the second command		: 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 [https://inkscape.org/report report a bug] or [https://chat.inkscape.org/channel/team_devel\ ask in chat]''.		☎ ''If you can't solve your issue with the information above, please [https://inkscape.org/report report a bug] or [https://chat.inkscape.org/channel/team_devel\ ask in chat]''.

Adambelis: formating

2024-06-25T16:22:03Z

formating

← Older revision		Revision as of 16:22, 25 June 2024
Line 18:		Line 18:
	To set-up MSYS2 and download the necessary dependencies only two steps are required:		To set-up MSYS2 and download the necessary dependencies only two steps are required:
	* '''Step 1''' — Install MSYS2		* '''Step 1''' — Install MSYS2
	*# Download the installer from the [http://www.msys2.org/ MSYS2 homepage] (a 64-bit version of Windows 7 or later is required to run MSYS2 and build Inkscape).<br />Start the installation and follow the instructions on screen. Wait until it finishes.		*# Download the installer from the [http://www.msys2.org/ MSYS2 homepage] (a 64-bit version of Windows 7 or later is required to run MSYS2 and build Inkscape).<br />Start the installation and follow the instructions on screen. Wait until it finishes.
	*# Start an MSYS2 '''MSYS''' shell (Do not use the one launched by the installer! use the "MSYS2 MSYS" shortcut in the start menu or launch "msys2.exe" in the installation directory). ~~<br />~~ Execute the command <code>pacman -Syuu</code>. This will start a full system upgrade and ensures that you have the latest versions of all core libraries.		*# Start an MSYS2 '''MSYS''' shell (Do not use the one launched by the installer! use the "MSYS2 MSYS" shortcut in the start menu or launch "msys2.exe" in the installation directory).
			*#Execute the command <code>pacman -Syuu</code>. This will start a full system upgrade and ensures that you have the latest versions of all core libraries.
	*# Repeat the previous step until no new updates are found.		*# Repeat the previous step until no new updates are found.
	* '''Step 2''' — Download dependencies		* '''Step 2''' — Download dependencies

Mgmax: /* Installing MSYS2 */ Minor clarifications. (Launching MSYS shell, install build dir)

2022-12-23T15:48:13Z

Installing MSYS2: Minor clarifications. (Launching MSYS shell, install build dir)

← Older revision		Revision as of 15:48, 23 December 2022
Line 19:		Line 19:
	* '''Step 1''' — Install MSYS2		* '''Step 1''' — Install MSYS2
	*# Download the installer from the [http://www.msys2.org/ MSYS2 homepage] (a 64-bit version of Windows 7 or later is required to run MSYS2 and build Inkscape).<br />Start the installation and follow the instructions on screen. Wait until it finishes.		*# Download the installer from the [http://www.msys2.org/ MSYS2 homepage] (a 64-bit version of Windows 7 or later is required to run MSYS2 and build Inkscape).<br />Start the installation and follow the instructions on screen. Wait until it finishes.
	*# Start an MSYS2 '''MSYS''' shell (~~you can work with~~ the one launched by the installer, use the "MSYS2 MSYS" shortcut in the start menu or launch "msys2.exe" in the installation directory). <br /> Execute the command <code>pacman -Syuu</code>. This will start a full system upgrade and ensures that you have the latest versions of all core libraries.		*# Start an MSYS2 '''MSYS''' shell (Do not use the one launched by the installer! use the "MSYS2 MSYS" shortcut in the start menu or launch "msys2.exe" in the installation directory). <br /> Execute the command <code>pacman -Syuu</code>. This will start a full system upgrade and ensures that you have the latest versions of all core libraries.
	*# Repeat the previous step until no new updates are found.		*# Repeat the previous step until no new updates are found.
	* '''Step 2''' — Download dependencies		* '''Step 2''' — Download dependencies
Line 80:		Line 80:
	== Packaging ==		== Packaging ==

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