Heathen Engineering

Install

This page covers Netcode Foundation for O3DE. The gem is not listed in the O3DE Project Manager yet, so you clone it and register it by path. Netcode Foundation is version 0.1.0, an early release. Interfaces, the Schema format and the wire format may change before 1.0.

Requirements #

  • O3DE 26.10 or 26.05, and a project you can build. Linux is the only tested platform.
  • Git.

Steps #

  1. Clone the gem with its submodule: git clone --recurse-submodules https://codeberg.org/Heathen-Engineering/O3DE-Netcode-Foundation
  2. Register it: o3de register --gem-path <path>/O3DE-Netcode-Foundation. Alternatively, add the folder to your project’s external_subdirectories.
  3. Add FoundationNetcode to your project’s gems, either in the Project Manager gem selection or in gem_names in project.json.
  4. Rebuild the project.
  5. Open the Editor and choose Tools, Netcode. If the tool opens, the gem is active.

Clone with --recurse-submodules. Without it the Core is missing and the gem will not build.

Dedicated Servers #

If you intend to run a Dedicated Server, your project must build its own server launcher, because the Netcode tool starts it for you. Set +sv_DedicatedMaxRate 120 for the server. Without it the server is capped near 33 frames per second, which adds about 60 ms to every round trip.

Checking the install #

The gem’s own tests are run with scripts/build-and-test.sh, which builds in a throwaway O3DE project that is not registered with the Project Manager. To confirm a project, open Tools, Netcode and the Subsystems window.

Next: Concepts.

Rate This Article!

Contents