Ixion builds on the community ports without changing them in place. Each port is a submodule on a fork branch that adds only what Ixion needs:
| Submodule | Fork branch | Upstream | Kazarov fork branch |
|---|---|---|---|
games/chronicle |
carrdylan52/Chronicle ixion |
TheMoonPeople/Chronicle master |
carrdylan52/Kazarov ixion-old-layout |
games/chronicletwo |
carrdylan52/ChronicleTwo ixion |
TheMoonPeople/ChronicleTwo master |
carrdylan52/Kazarov ixion |
Each port's tools/kazarov points at its Kazarov fork branch, which adds embedded mode
(platform/embed.hpp). Ixion pins exact commits, so nothing breaks when upstream moves; catching up
only brings in upstream's fixes and features. Do it every few weeks or before a milestone.
tools/sync_upstream.py does the mechanical part. It never force-pushes, never pushes to
TheMoonPeople, and never opens pull requests.
- First time in a checkout:
python tools/sync_upstream.py init. It checks out the submodules on their branches and adds anupstreamremote to each. Set a git identity in each submodule if your global one is not set. - Look:
python tools/sync_upstream.py status. Per port: how many commits it is behind, the files Ixion changes there, and whether upstream's Kazarov pin is already merged. - Merge:
python tools/sync_upstream.py merge chronicle(orchronicletwo). By default it merges upstream's tip.--to last-greenmerges the newest upstream commit whose "PC builds" CI passed (needs the GitHub CLI);--to <sha>merges a chosen commit. The script merges upstream's Kazarov pin into the Kazarov fork branch first, then upstream into the port, and records the merged Kazarov in the port. Nothing is pushed. - If it stops on conflicts: resolve them by keeping upstream's behaviour and re-applying the
Ixion seam (the files
statuslists). Never editps2/src.git addthe files,git commit, and rerun the samemergecommand; it carries on from where it stopped. - Build and test, all of these:
- the port's own tests (its README), so the standalone game still works;
- the port's module with
-DIXION_BUILD_PLUGIN=ON -DIXION_API_DIR=<Ixion>/include, and check that it exports onlyixion_get_api(llvm-readobj --coff-exports); - the host (
host/build-windows.ps1), the fiber self-test (ixion_fiber_smoke.exe), andixion.exe ... --auto-switch 120:20with fresh save folders: it must exit 0 withauto-switch PASS.
- Push:
python tools/sync_upstream.py push chronicle. It pushes the Kazarov branch first, then the port branch, fast-forward only. A refused push means someone else moved the branch: fetch, merge, test again. - Pin:
python tools/sync_upstream.py bump --push. It refuses to pin a commit that is not on the fork yet, commits "Bump ports: ...", and pushes Ixion.
Chronicle still pins the older Kazarov layout (code under port/); ChronicleTwo pins the current
one (src/cpp/, include/). If upstream Chronicle moves to the current layout, status warns and
merge stops. Then the port should switch to the ixion Kazarov branch: point the port's
.gitmodules branch at ixion, check out the ixion branch (or a commit that merges upstream's
new pin into it) in tools/kazarov, rebuild, and change kazarov_branch for that port in
tools/sync_upstream.py. The ixion-old-layout branch then retires.
Local mirrors go in tools/sync.local.json (ignored by git):
{"mirrors": {"chronicle": "<url>", "chronicletwo": "<url>", "kazarov": "<url>", "ixion": "<url>"}}push and bump --push push to these too, with the same fast-forward-only rule.