Halo: Modding References & Tools
Table of Contents
- Loading table of contents...
Essential references and tools for Halo PC and Custom Edition (CE) modding, from classic HEK utilities to modern cross-platform toolchains. Covers weapon stat tweaking, custom multiplayer maps, and server-side Lua scripting.
Official Documentation and Community Hubs
Official docs, forums, map repositories, and community knowledge bases.
- SAPP Documentation (mirror):
- Official SAPP Docs: Lua API, events, commands, and examples for the SAPP server extension.
- Scripting with SAPP: Comprehensive guide to server-side Lua scripting using SAPP’s Lua API, including signature scanning, global variables, and core functions.
- Scripting with Phasor: Server-side Lua scripting with Phasor, covering version handling and hardcoded addresses.
- Phasor (legacy): Legacy server extension and documentation; useful for older scripts and historical examples.
- Phasor V1 Docs: Documentation for Phasor V1.
- Phasor V2 Docs: Documentation for Phasor V2.
- The Reclaimers Library (c20): Community-maintained technical reference covering the Halo Editing Kit, engine internals, map-making workflows, and modern tooling.
- Halopedia - Halo: Combat Evolved: Community-maintained wiki with detailed information about gameplay systems, tags, weapons, vehicles, and campaign content.
- Halopedia - Weapons category: Full list of Halo: CE weapons and related articles.
- OpenCarnage: Forums, HEK help, scripts, and CE community discussions.
- Elite Game Servers - SAPP overview: Practical SAPP usage notes and examples.
- HAC2 Map Repo: Custom maps for Halo PC and Custom Edition.
- HaloMaps.org: Large archive of Halo Custom Edition maps and releases.
Deep Dives and Networking
When you need to understand netcode, packet loss, memory offsets, or the Halo 1 system link protocol:
- Netcode (Wikipedia): General networking concepts (tickrate, latency, packet loss) useful for multiplayer synchronization and debugging.
- Exploring the Halo 1 System Link Protocol (hllmn.net, 2023): Low-level reverse engineering of CE networking and packet structures.
- Understanding Memory Offsets: Foundational guide to memory addresses, offsets, signature scanning, and tools for finding offsets in Halo PC/CE.
Modding Tools
There are two main eras of tooling: the classic HEK suite and modern community replacements.
Classic HEK (Halo Editing Kit)
These are the original tools Bungie released for Halo Custom Edition. They still work, but may require some patience on modern versions of Windows.
- HEK on Nexus Mods: The original Halo Editing Kit installer.
- H1 Editing Kit Reference (c20): Detailed explanation of the HEK tools, workflows, and differences between legacy HEK and modern H1A-EK setups.
- Sapien: Scenario and map editor (in-editor placement, scenario preview, radiosity).
- Guerilla: Structured tag editor for weapons, bipeds, vehicles, shaders, and gameplay tuning.
- Tool: Command-line asset compiler used for bitmaps, models, sounds, and map builds.
- Tag Test (
tag_test.exe): Launch and debug maps locally without a dedicated server.
Warning: Classic HEK tools are 32-bit and may need compatibility settings (Windows 7 mode, admin rights). Some users report improved stability with
dgVoodoo2as a DirectX wrapper.
Modern and Community Toolchains
These tools are cross-platform, scriptable, and actively maintained by the community.
- Invader: Modern, cross-platform toolkit for extracting, building, and modifying Halo maps. Designed as a modern replacement for many classic HEK workflows.
- Assembly: Multi-generation
.mapeditor and patcher developed by XboxChaos. Excellent for quick edits, experimentation, and patching existing maps. - MEK (Mozz Editing Kit): Alternate editing suite with extraction tools and graphical utilities.
- OpenSauce: Advanced Halo CE engine extension adding expanded scripting, rendering, and engine-level modding features.
Tip: Use Invader if you need batch workflows, CI integration, or want to avoid many of the classic HEK quirks. Assembly is ideal for quick testing and lightweight map edits, while larger projects are generally easier to maintain through proper tag-based rebuild workflows.
Client-Side Mods and Scripting Platforms
Enhance your local game or test scripts without needing a dedicated server.
- Chimera: Halo CE client modification with Lua support, quality-of-life features, and modding APIs.
- Scripting with Chimera: Client-side Lua scripting with Chimera, including event callbacks, script placement, and version compatibility.
- Balltze: Plugin loader and mod platform for Halo CE. Documentation: balltze.shadowmods.net
Lua Scripting Helpers and Package Management
These libraries and utilities make writing and distributing CE Lua scripts easier.
- lua-blam: Memory and tag helper module for Halo CE Lua scripting.
- Mercury: Package manager for Halo CE mods. Helps package, install, remove, and distribute addons cleanly.
Best Practice: Use Mercury to organize reusable mods, scripts, and dependencies for easier sharing and deployment.
Asset Pipelines and Blender Tools
If you are creating custom models or importing assets, these Blender addons and utilities are essential.
- Halo Asset Blender Development Toolset: Import and export Halo CE assets directly in Blender.
- Other community tools: Search GitHub for
ekur,Foundry, orblender-halo-toolsto find additional importers, exporters, and workflow utilities.