OpenCE README

The project's README from github.com/OpenCommunityEdition/OpenCE. As one markdown file: README.md.

Halo: Combat Evolved for Linux, Windows and Android

Join our Discord

This project is a port of the Halo: Combat Evolved decompilation to Linux, Windows and Android. The decompilation is of the Xbox build 2342 (cachebeta.exe, SHA-256 4cc87b45f721270392a96f1674ed2b5cd4a7bb4355faeab4531d1cf1884d9520).

The game on Linux

The port starts from the decompilation of bnunu/halo-1. That project is a fork of punpckhdq/halo.

Download

GitHub Actions builds the game for each commit. These links download the builds of the latest release:

Platform Release Debug
Linux halo-linux-release.zip halo-linux-debug.zip
Windows halo-windows-release.zip halo-windows-debug.zip
Android halo-android-release.zip halo-android-debug.zip

Use the release build to play. The debug build stops at the first failed assertion and writes it to the log. Use the debug build to find and report problems.

The game updates itself. At start-up it looks for a newer release, and asks if you want to install it. Refer to "Updates" in port/linux/README.md.

Each build of the main branch that passes on all three platforms is a new release. The Releases page keeps the last five releases. If the latest build has a problem, get an older build from that page.

Game data

The port does not include the game data. Download an Xbox disc image (.xiso or .iso) of Halo: Combat Evolved. All versions of the game operate. The maps of the European (PAL) version were made for a slower console. The port changes them to play as the North American (NTSC) maps do, so players of the two versions can play together.

  1. Start the game.
  2. At the first start, the game asks for the disc image. Select it.
  3. The game extracts the maps/ folder. Then the game starts.

On Linux and Windows, the game puts maps/ next to the executable. On Android, copy the disc image to the phone first. The app puts maps/ in its data folder. Refer to port/android/README.md.

Platforms

Each platform has its own instructions:

Platform Instructions
Linux (32-bit x86 executable, OpenGL 4.5, SDL3) port/linux/README.md
Windows (32-bit x86 executable, OpenGL 4.5, SDL3) port/windows/README.md
Android (arm64 app, OpenGL ES 3, SDL3) port/android/README.md

The Linux README also gives the controls, the settings and the multiplayer functions. These are almost the same on all platforms.

Multiplayer

The game can play system link games on a local network and on the internet:

Build the game

You do not need the Xbox SDK. The port supplies the SDK declarations that the game uses. Refer to port/include/xdk.

To build the game:

  1. Install Python and ninja.
  2. Install the tools for your platform. Refer to the README for the platform.
  3. In the root folder of the repository, enter python configure.py.
  4. Enter ninja with the target for the platform:
Target Result
ninja linux build/linux/halo
ninja windows (on Windows) build/windows/halo.exe and SDL3.dll
ninja android_apk port/android/app/build/outputs/apk/debug/app-debug.apk

If you enter ninja without a target, ninja builds the game for the computer that you use.

tools/ci_build.py makes the same builds as GitHub Actions. For example, enter python tools/ci_build.py linux release.

Build options

Give these options to configure.py:

Option Result
(none) A debug build. A failed assertion stops the game.
--release A release build. The game does not examine assertions, as in the retail game.
--portable The Linux and Windows builds operate on all x86-64 processors. Use this option for builds that you give to other persons.
--lto=thin, --lto=off Less link-time optimization. The link is faster.
--pgo=off No profile-guided optimization.
--pgo=train Records a new optimization profile. Refer to "Optimization profiles".

Without --portable, the Linux and Windows builds use all the instructions of the processor that builds them (-march=native). Such a build does not always start on a different computer.

Optimization profiles

The builds use profiles of the game to optimize the code:

The profiles need clang 22 or later. With an older clang, the builds do not use the profiles.

To record a new profile:

  1. Delete the profile.
  2. Enter python configure.py --pgo=train.
  3. Enter ninja linux or ninja windows.

The build then plays the main menu and the first minute of each campaign level. This procedure continues for approximately 15 minutes. The game data must be in assets/.

OpenCE (OpenCommunityEdition/OpenCE)

Searching Database…

1.6K ·GitHub
OpenCE
What is this?OpenCE is a port of the Halo: Combat Evolved decompilation (originally for the original Xbox) to Linux, Windows and Android, letting the game run natively on those platforms.
Is this a full game or just a compatibility layer?It is the actual game engine rebuilt from decompiled Xbox code into native executables for each platform; you still need to supply your own copy of the game data separately.
How do I get it running?Download the prebuilt release build for your platform from GitHub Actions/Releases, run it, and when prompted at first start select your Xbox disc image so the game can extract the maps folder.
What do I need besides the port itself?You need an Xbox disc image (.xiso or .iso) of Halo: Combat Evolved to supply the game data; building from source additionally requires Python, ninja and platform-specific tools.
Will my European (PAL) disc work the same as the US version?Yes, all versions work, but the port converts PAL maps to match the faster North American (NTSC) maps so players of either version can play together online.
Does it work on any Linux or Windows PC, or only specific chips?Linux and Windows builds are 32-bit x86 executables; by default they're optimized for the build machine's CPU and may not run elsewhere unless built with the --portable option, which targets all x86-64 processors.
Which platforms are supported and what do they use under the hood?Linux and Windows run as 32-bit x86 executables using OpenGL 4.5 and SDL3; Android runs as an arm64 app using OpenGL ES 3 and SDL3.
How does multiplayer work and do I need a dedicated server?The game supports system link games over LAN or the internet with up to 128 players on up to 128 machines, mixing Linux, Windows and Android players together; an invite link lets someone join an internet game without needing a server for this project.
Does the game update itself?Yes, at start-up it checks for a newer release and offers to install it automatically.
What's the difference between the release and debug builds?The release build is for normal play and skips assertion checks like the retail game, while the debug build halts on the first failed assertion and logs it, which is useful for reporting bugs.
What are similar projects?OpenRCT2, re4, th08, Wind-Waker-Recomp, LASRecomp, iw4L, luanti, Petari
Which topics is it in?decompilation, sdl2, decompiler, multiplayer, linux-app, retrogaming, game-engine, gamedev, android-app, game, windows-app, gaming
Creator
OpenCommunityEdition
Size
51.3 MB
Stars
1.6K
Updated
CommitOct 17Releasebuild-217Oct 17
Age
21d
Commits · 90 Days