eden-emu/eden
24
3
Fork 15
Code Issues 138 Pull requests 55 Projects 1 Releases Packages Wiki Activity Actions
eden/docs/scripts/Windows.md
crueter b7f2aa3dbd
[docs] refactor: full rewrite, generalization + dedup 
Combines most of the stuff that was repeated thrice over verbatim into a
single common Build Instructions page, with additional caveats marked
elsewhere. Prettifies some stuff too because why not.

Signed-off-by: crueter <crueter@eden-emu.dev>
2025-09-15 00:16:55 -04:00

3.2 KiB
Raw Blame History

Windows Build Scripts

  • A convenience script for building is provided in .ci/windows/build.sh.

  • You must run this with Bash, e.g. Git Bash or the MinGW TTY.

  • To use this script, you must have windeployqt installed (usually bundled with Qt) and set the WINDEPLOYQT environment variable to its canonical Bash location:

    • WINDEPLOYQT="/c/Qt/6.9.1/msvc2022_64/bin/windeployqt6.exe" .ci/windows/build.sh.

  • You can use aqtinstall, more info on https://github.com/miurahr/aqtinstall and https://ddalcino.github.io/aqt-list-server/

  • Extra CMake flags should be placed in the arguments of the script.

Additional environment variables can be used to control building:

  • BUILD_TYPE (default Release): Sets the build type to use.

  • The following environment variables are boolean flags. Set to true to enable or false to disable:

    • DEVEL (default FALSE): Disable Qt update checker

    • USE_WEBENGINE (default FALSE): Enable Qt WebEngine

    • USE_MULTIMEDIA (default FALSE): Enable Qt Multimedia

    • BUNDLE_QT (default FALSE): Use bundled Qt

    • Note that using system Qt requires you to include the Qt CMake directory in CMAKE_PREFIX_PATH

      • .ci/windows/build.sh -DCMAKE_PREFIX_PATH=C:/Qt/6.9.0/msvc2022_64/lib/cmake/Qt6

  • After building, a zip can be packaged via .ci/windows/package.sh. You must have 7-zip installed and in your PATH.

    • The resulting zip will be placed into artifacts in the source directory.

🖥️ Method III: CLion Environment Setup

a. Prerequisites to CLion

  • CLion - This IDE is not free; for a free alternative, check Method I

b. Cloning eden with CLion

  • Clone the Repository:

c. Building & Setup

  • Once Cloned, You will be taken to a prompt like the image below:
  • Set the settings to the image below:
  • Change Build type: Release
  • Change Name: Release
  • Change Toolchain Visual Studio
  • Change Generator: Let CMake decide
  • Change Build directory: build
  • Click OK; now Clion will build a directory and index your code to allow for IntelliSense. Please be patient.
  • Once this process has been completed (No loading bar bottom right), you can now build eden
  • In the top right, click on the drop-down menu, select all configurations, then select eden
  • Now run by clicking the play button or pressing Shift+F10, and eden will auto-launch once built.