helium-windows

Windows packaging for Helium.

Credits

This repo is based on ungoogled-chromium-windows, but is pretty heavily modified for Helium. Huge shout-out to everyone behind ungoogled-chromium, they made working with Chromium infinitely easier.

A huge thank you to Depot for sponsoring our runners, which handle the Windows builds of Helium. Their high-performance infrastructure lets us compile and package Helium at least 8 times faster than with GitHub-hosted runners, allowing us to release new builds within hours, not days.

License

All code, patches, modified portions of imported code or patches, and any other content that is unique to Helium and not imported from other repositories is licensed under GPL-3.0. See LICENSE.

Any content imported from other projects retains its original license (for example, any original unmodified code imported from ungoogled-chromium remains licensed under their BSD 3-Clause license).

Building

Setting up Visual Studio

Follow the "Visual Studio" section of the official Windows build instructions.

• Make sure to read through the entire section and install/configure all the required components.
• If your Visual Studio is installed in a directory other than the default, you'll need to set a few environment variables to point the toolchains to your installation path. (Copied from instructions for Electron)
  • vs2019_install = DRIVE:\path\to\Microsoft Visual Studio\2019\Community (replace 2019 and Community with your installed versions)
  • WINDOWSSDKDIR = DRIVE:\path\to\Windows Kits\10
  • GYP_MSVS_VERSION = 2019 (replace 2019 with your installed version's year)

Other build requirements

IMPORTANT: Currently, the MAX_PATH path length restriction (which is 260 characters by default) must be lifted in for our Python build scripts. This can be lifted in Windows 10 (v1607 or newer) with the official installer for Python 3.6 or newer (you will see a button at the end of installation to do this). See Issue #345 for other methods for older Windows versions.

1. Setup the following:
   • 7-Zip
   • Windows Developer Mode enabled (for creating symbolic links).
   • Python 3.11 or above
     • Can be installed using WinGet or the Microsoft Store.
     • If you don't plan on using the Microsoft Store version of Python:
       • Check "Add python.exe to PATH" before install.
       • At the end of the Python installer, click the button to lift the MAX_PATH length restriction.
       • Disable the python3.exe and python.exe aliases in Settings > Apps > Advanced app settings > App execution aliases. They will typically be referred to as "App Installer". See this question on stackoverflow.com to understand why.
       • Ensure that your Python directory either has a copy of Python named "python3.exe" or a symlink linking to the Python executable.
     • requests and Pillow. Install with python -m pip install requests Pillow; ensure Python's Scripts directory is on PATH.
   • Make sure to lift the MAX_PATH length restriction, either by clicking the button at the end of the Python installer or by following these instructions.
   • Git (to fetch all required ungoogled-chromium scripts)
     • During setup, make sure "Git from the command line and also from 3rd-party software" is selected. This is usually the recommended option.

Building

Run in Developer Command Prompt for VS (as administrator):

git clone --recurse-submodules https://github.com/imputnet/helium-windows.git
cd helium-windows
# Replace TAG_OR_BRANCH_HERE with a tag or branch name
git checkout --recurse-submodules TAG_OR_BRANCH_HERE
python3 build.py
python3 package.py

A zip archive and an installer will be created under build.

NOTE: If the build fails, you must take additional steps before re-running the build:

• If the build fails while downloading the Chromium source code (which is during build.py), it can be fixed by removing build\download_cache and re-running the build instructions.
• If the build fails at any other point during build.py, it can be fixed by removing everything under build other than build\download_cache and re-running the build instructions. This will clear out all the code used by the build, and any files generated by the build.

An efficient way to delete large amounts of files is using Remove-Item PATH -Recurse -Force. Be careful however, files deleted by that command will be permanently lost.

Developer info

First-time setup

1. Setup MSYS2
2. Run the following in a "MSYS2 MSYS" shell:

pacman -S quilt python3 vim tar
# By default, there doesn't seem to be a vi command for less, quilt edit, etc.
ln -s /usr/bin/vim /usr/bin/vi

Updating patches and pruning list

1. Start Developer Command Prompt for VS and MSYS2 MSYS shell and navigate to source folder
   1. Developer Command Prompt for VS
      • cd c:\path\to\repo\helium-windows
   2. MSYS2 MSYS
      • cd /path/to/repo/helium-windows
      • You can use Git Bash to determine the path to this repo
      • Or, you can find it yourself via /<drive letter>/<path with forward slashes>
2. Clone sources Developer Command Prompt for VS
   • python3 helium-chromium\utils\clone.py -o build\src
3. Update pruning list Developer Command Prompt for VS
   • python3 helium-chromium\devutils\update_lists.py -t build\src --domain-regex helium-chromium\domain_regex.list
4. Update patches MSYS2 MSYS
   1. Setup patches and shell to update patches
      • ./devutils/update_patches.sh merge
      • source devutils/set_quilt_vars.sh
   2. Go into the source tree
      • cd build/src
   3. Use quilt to refresh patches. See ungoogled-chromium's docs/developing.md section "Updating patches" for more details
   4. Go back to repo root
      • cd ../..
   5. Remove all patches introduced by helium-chromium
      • ./devutils/update_patches.sh unmerge
   6. Sanity checking for consistency in series file
      • ./devutils/check_patch_files.sh
5. Use Git to add changes and commit