Halo 3 ODST Editing Kit

This page is incomplete! You can contribute information using GitHub issues or pull requests.

The Halo 3 ODST Editing Kit (H3ODSTEK) is the official set of tools for creating custom content for the MCC version of Halo 3 ODST. It was first released by 343 Industries alongside the latest update as of March 2022. Similarly to the mod tools for Halo 1, 2, and 3 it is ultimately based on the old internal tools used by Bungie during the development of Halo 3, with modifications made during the porting of the game to MCC and some changes to make them more user-friendly.

Unlike the H1A-EK you do need to own Halo 3 ODST on Steam to gain access to the toolkit.

Getting started

Pictured: Location of the mod tools in the steam library.

  1. Ensure you own Halo 3 ODST on Steam, tools are only accessible if you own the Steam version.
  2. Download the tools using Steam, you might need to install Steam first.
  3. Follow the on screen prompts to download the tools.
  4. Once the tools are done downloading you can find them in your library in the tools section.
  5. Right click the entry for the mod tools, select the "Manage" context menu entry then select the "Browse local files" subentry.
  6. Run the H3ODSTEK (Extract).bat file - this will extract all the files required.
  7. If your operating system supports it you should enable file system compression for the tags\sounds folder. This is a workaround for high disk space usage caused by sound tags including zeroed out sound data.
  8. (Optional) Check out the guides hub to learn more about modding or install a launcher like Osoyoos if you don't like using the command line.

Changelog

What's new in the September update

Installing the September update

  1. Delete the shader templates from the previous update as they are not compatible, delete tags\shaders\beam_templates, tags\shaders\black_templates, tags\shaders\contrail_templates, tags\shaders\custom_templates, tags\shaders\decal_templates, tags\shaders\foliage_templates, tags\shaders\halogram_templates,tags\shaders\light_volume_templates, tags\shaders\particle_templates, tags\shaders\screen_templates, tags\shaders\shader_templates, tags\shaders\terrain_templates and tags\shaders\water_templates. 2a. (recommended) Extract the new H3ODSTEK.7z. 2b. (alternative) If you don't want to update all your tags it's highly recommended you at least update the tags\shaders folder.

Content

  • Various changes to tags and data files. Updating your tag set is highly recommended.
  • Added test, audio and lighting reference scenarios levels\test\box, levels\reference\audio, levels\reference\lighting_reference
  • Map info files have been added to the H3ODSTEK.7z which allows the main menu to load maps.

General

  • Maximum string storage for cache files increased.
  • New flag for equipment to prevent AI from dropping them on death.
  • Script doc has new formatting and will now contain globals.
  • Reports are now contained within the reports folder.
  • Giants will now synchronize in co-operative Firefight games.

Tool

  • New commands extract_unicode_strings and print_tag_to_XML added.
  • Various improvements to the export-tag-to-xml command output.
  • Export bitmap commands now have support for cubemaps.
  • The build-cache-file command now uses the flag use-fmod-data by default which should result in smaller cache files.

Guerilla

  • Reserved chud text stringids are now listed.

Sapien

  • Additional FMOD banks no longer stops working after a map reset.

Standalone

  • Additional FMOD banks no longer stops working after a map reset.
  • Firefight maps can now be successfully launched from the main menu.

May 2022 Patch

  • Tags were updated to include the balance changes from the corresponding MCC update.

Major changes from H2

Naturally there is multitude of changes compared to H2 as the engine underwent a major revision, this document endeavours to list the major ones.

  • Tools now are all 64-bit, no more out of memory errors unless you actually run out of memory.
  • The graphics and tag subsystems went through major revisions.
  • Structures can no longer be created using JMS files, you need to use ASS files.
  • Tag import info is not stored in a tag block but in a separate tag stream
  • Debug logs are not saved in a single folder anymore, allowing you to run multiple tools at once without confusing logs.
  • Shader tag creation was streamlined, you no longer need to select a template.
  • If a shader template does not exist then it will be autogenerated.
  • Lightmap baking is usually faster.
  • Multiple structure tags can be loaded at once, the basic subdivision of a scenario is now the zone set.
  • A fancy new green loading screen.

Known issues

  • Resource sharing is currently not supported.
  • Halo 3 ODST custom maps require that EAC is turned off to load
  • Halo 3 ODST custom maps requires that the map info matches the map it is replacing to load. This means having the same campaign and map ID. These values can be found at the top of the scenario tag.
  • Single threaded lightmapping is not supported, you need to use the multi-process solution. This can be run with only a single client if only using one core is desired.
  • Sound playback and sound importing require the FSB files that come with MCC in order to function. Copy the FSB files from your Halo 3 ODST MCC install.
  • Guerilla uses red text and greyed out folders for all tags - this doesn't mean there is something wrong with your tags it's just a graphical issue.
  • Lipsync won't be generated when importing sounds that use a multilingual sound class such as unit_dialog as third party tools are required.