Skip to content
This repository has been archived by the owner on Nov 8, 2023. It is now read-only.

Build Instructions of heX and HeXium (English)

Lu Yuan edited this page Apr 8, 2014 · 1 revision

Build Instructions of heX and HeXium

Instructions for downloading, building and packaging the source code of heX.

Background Knowledge

heX depends on the Chromium, CEF and Node.js projects. Before getting the source code of heX, user should prepare the specified revision source code of Chromium. The source code of CEF and Node.js is not required, because the tools will get them automatically.

The home pages of these projects:

Fast way to getting the source code of Chromium

There are detailed steps for downloading in the Wiki of Chromium project by using svn or git, and depot_tools. Refer to http://dev.chromium.org/developers/how-tos/get-the-code.

Chromium is a huge project, getting the code from subversion will take lots of time. Downloading the source tarball may save the valuable time.

  1. Open this link in browser: http://chromium-browser-source.commondatastorage.googleapis.com.
  2. Look up the specified revision number of Chromium we need from the file CHROMIUM_BUILD_COMPATIBILITY
  3. Find the nearest revision in the link above. E.g. finding rXXXXXX.
  4. Download the nearest revision's tarball.
  5. Untar it and enter the parent of src directory.
  6. Execute gclient sync --revision src@{specified revision number} --force --jobs 32.
  7. Few minutes later, the specified revision source code of Chromium is updated. (Note: The revision list of step one seems to stop updating after Chromium uses Blink.

Check out the source code of heX

The source code of heX must under the src directory of Chromium sources. The URL is https://github.com/netease-youdao/hex.git. When the source code is checked, the directory structor may be:

src - base
      hex
      ...

Preparing Build Environment

Building from source code of heX os currently supported in Windows temporarily. And At least 4GB of system memory is required.

To build Chromium, CEF and heX from source code, you must start by configuring your build environment. Install the build prerequisites for your operating system and development environment. Please refer to

After configure works above, you need to download the specified revision of Node.js and CEF, and generate the project file by using GYP. For Windows, just execute hex.bat or hex_end_user.bat (end user version) in the heX source directory.

Build heX

GYP will generate the projects according to the current operating system.

  • Windows: open generated hex.sln by Visual Studio, set hexclient project as startup project, build!
  • Mac OS X: open generated hex.xcodeproj by Xcode, build!

After a while (depending on the hardware configuration of your computer), you can find the result in src/hex/build directory.

Build HeXium

Basically, HeXium is Chromium modified and integrated Node.js, and do not need CEF.

After running hex.bat, enter the parent directory of src, and execute gclient runhooks to ensure that all the projects of HeXium can be generated correctly.

After generating, enter src\chrome directory and find

  • Windows: chrome.sln
  • Mac OS X:chrome.xcodeproj

Open it with the default IDE, build!

After more time (depending on the hardware configuration of your computer), you will find the result in

  • Windows:src/build/Debug or Release
  • Mac OS X:src/xcodebuild/Debug or Release

directory.