Merge pull request #210 from Ghabry/windows-qt6

Windows: Add Qt6 and Editor install script

Author: carstene1ns

macos/download_qt6.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# Downloads the Qt6 precompiled libraries
+# These are the official ones from the Qt Project
+# Compiling Qt6 is not feasible as it takes hours
+
+curl -LO "https://github.com/miurahr/aqtinstall/releases/download/v3.3.0/aqt-macos"
+
+chmod +x aqt-macos
+
+./aqt-macos install-qt -O qt mac desktop 6.10.1 clang_64 -m all

windows/README.md

@@ -11,8 +11,8 @@ The ARM architecture is not supported.
 
 ## Compiling
 
- - For EasyRPG Player: Run build.cmd
- - For EasyRPG Editor: (currently unsupported)
+ - For EasyRPG Player: Run `build.cmd`
+ - For EasyRPG Editor: Run `download_qt6.cmd` and `build_editor.cmd` 
 
 This bootstraps vcpkg and builds all required libraries.
 
@@ -26,14 +26,14 @@ prebuilt version. Run ``download_prebuilt.cmd`` to obtain them.
 This precompiled version will only work on the latest version of Visual Studio
 2022. If you are using a different version, please compile it yourself.
 
-## After compiling
-
-### Environment setup
+## Environment setup
 
 Run ``setup_env.cmd`` once to configure the necessary environment variables.
 
 Then log out of Windows to ensure that the changes take effect.
 
+## Compile instructions for EasyRPG Player
+
 ### Configuring
 
 Open the "Developer Command Prompt for Visual Studio 2022" from the Start menu
@@ -71,5 +71,44 @@ Player.
 Open the ``EasyRPG_Player.sln`` file created in ``build\[PRESET]`` in Visual
 Studio (``[PRESET]`` is equal to the value after ``--preset`` above).
 
-When the build type is different to Debug, you must set the correct build type
-manually in Visual Studio, otherwise you will get strange build errors.
+## Compile instructions for EasyRPG Editor
+
+### Enabling Long Path Support
+
+Compiling the editor fails because the path length of the Kirigami dependency
+exceeds the legacy Windows limit of 260 characters.
+
+To resolve this issue, either enable long path support in the Windows 11
+Developer Settings, or run the following command in PowerShell as an
+administrator:
+
+```psh
+New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" `
+  -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
+```
+
+### Configuring
+
+Open the "Developer Command Prompt for Visual Studio 2022" from the Start menu
+and navigate to your _EasyRPG Editor_ directory.
+
+To configure the editor run:
+
+```
+cmake --preset windows-x64-vs2022-[BUILD_TYPE]
+```
+
+liblcf is not provided by the buildscript. Either compile it yourself or use
+the triplet `windows-x64-vs2022-liblcf-[BUILD_TYPE]` to build it as part of
+the Editor.
+
+Options for ``[BUILD_TYPE]``:
+
+- ``debug``: Debug build
+- ``relwithdebinfo``: Release build with debug symbols
+- ``release``: Release build without debug symbols
+
+### Building
+
+Open the ``EasyRPG_Editor.sln`` file created in ``build\[PRESET]`` in Visual
+Studio (``[PRESET]`` is equal to the value after ``--preset`` above).

windows/build_editor.cmd

@@ -0,0 +1,10 @@
+:: Builds the dependencies for EasyRPG Editor
+
+call helper\prepare.cmd
+
+:: Build 64-bit libraries
+vcpkg install --triplet x64-windows-static-easyrpgeditor --recurse^
+ zlib[core] expat[core] inih[cpp] nlohmann-json[core] glaze[core]
+
+:: Other dependencies such as Kirigami are built via vcpkg.json and a custom
+:: overlay in the editor repository. This makes updating them easier.

windows/build_qt5.cmd

@@ -0,0 +1,7 @@
+:: Downloads the Qt6 precompiled libraries
+:: These are the official ones from the Qt Project
+:: Compiling Qt6 is not feasible as it takes hours
+
+curl -LO "https://github.com/miurahr/aqtinstall/releases/download/v3.3.0/aqt.exe"
+
+aqt install-qt -O qt windows desktop 6.10.1 win64_msvc2022_64 -m all

windows/download_qt6.cmd

@@ -18,6 +18,9 @@ git restore -s 50ca16008cebab427e90a98f8ffc34208b215dba ports/fmt
 :: Optimize the debug libraries
 copy ..\helper\windows.cmake scripts\toolchains\windows.cmake
 
+:: add custom editor triplet
+copy ..\helper\x64-windows-static-easyrpgeditor.cmake triplets\x64-windows-static-easyrpgeditor.cmake
+
 :: Copy custom portfiles
 :: ICU static data file
 xcopy /Y /I /E ..\icu-easyrpg ports\icu-easyrpg

windows/helper/prepare.cmd

@@ -0,0 +1,8 @@
+set(VCPKG_TARGET_ARCHITECTURE x64)
+# Qt6 uses the dynamic CRT (/MD)
+# The CRT must match for all linked libraries
+set(VCPKG_CRT_LINKAGE dynamic)
+set(VCPKG_LIBRARY_LINKAGE static)
+# Use our downloaded Qt6 prebuild
+# Compiling Qt6 manually takes hours
+set(VCPKG_ENV_PASSTHROUGH Qt6_Path)