iw4L README

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

IW4L

IW4L is a Call of Duty runtime written from scratch in Rust, on bevy and wgpu. Point it at a copy of MW2 you already own and it loads that install's data into its own engine.

The on-disk layouts came out of reverse engineering the original binaries and reading public technical references.

This whole project is written by an LLM.

Status

No releases yet: you build it from this tree. Nothing here is stable either — the API, the config format, caches and the wire protocol all change between commits, so everyone in a session needs to be on the same one. Expect bugs and desyncs.

The network side is for arranged playtests among people who already agreed to play; it has never been vetted for lobbies full of strangers. IW4L sends nothing home, and diagnostic files sit on your disk until you attach them to a report.

Architecture
assets MW2 zones read natively; MW3 and Black Ops land in the same asset_iw4 IR.
shaders Retail D3D9 SM3 tokens translated to WGSL, so no DirectX at runtime.
rendering One sorted drawsurf list; only the tess emitters fork per surface type.
physics Fixed 17 ms step on its own accumulator. Framerate changes nothing about how a body falls.
simulation One TickInput → sim::step → Snapshot funnel for server, prediction and replay.
network Custom p2p wire over UDP: deltas, reliability, reconciliation. A QUIC master only introduces peers.
platforms Linux, macOS (Metal) and a portable Windows build.

Retail protocols, the original ABI and patched executables are out of scope. IW4L clients talk to IW4L clients.

Game data

IW4L_GAMES points at the folder holding your game trees. No assets ship in this repository or in any release, and IW4L is unaffiliated with the rights holders of the original games.

Those trees are read only. IW4L never patches them, swaps files in them or writes anything back; caches, settings, demos and logs land in iw4l-artifacts/ next to the IW4L binary.

Build and run

System packages first: docs/BUILD.md (Fedora / Debian / Arch — compiler, ALSA, udev, X11/Wayland headers; macOS — Xcode command line tools).

cp .env.example .env          # IW4L_GAMES — folder containing the game trees
make map mp_boneyard          # run a map
make map mp_boneyard CMDS='spawn 0; wait 2s; quit'
make help                     # every recipe

Live runs use [profile.play], a development build with optimizations turned on. PROFILE=release builds the real release binary. docs/WINDOWS.md covers Windows.

Documentation

Implementation notes live under docs/, one short file per area. Start at docs/INDEX.md.

file about
docs/BUILD.md system packages per distro, macOS, Windows cross prerequisites
docs/RUN.md running the game, console scripts, commands and traps
docs/PERF.md Perfetto tracing and performance analysis
docs/RENDER.md rendering pipeline
docs/MAP-LOAD.md map loading and asset installation
docs/ENTITIES.md simulation data flow and entity taxonomy
docs/SIM-STEP.md simulation step architecture
docs/ANIM.md animation system
docs/WINDOWS.md portable Windows build
docs/DEPLOY.md release, publishing and deployment
docs/MASTER.md running your own master server

Contributing and support

A personal, experimental project. Bug reports are welcome and get no promised fix date. CONTRIBUTING.md says what a useful report contains and how changes get reviewed; security reports go to SECURITY.md.

Acknowledgements

IW4L ships none of the code below. It was read against all of it.

License

IW4L is licensed under the Apache License 2.0, and NOTICE holds the copyright notices, the licences of the projects above and the bundled fonts. That licence covers IW4L's own source code. Call of Duty, Modern Warfare, Black Ops and the related assets, trademarks and intellectual property belong to their respective owners.

iw4L (vladtrc/iw4L)

Searching Database…

1.1K ·GitHub
Iw4L
Что это?IW4L — среда исполнения Call of Duty, написанная с нуля на Rust поверх Bevy и wgpu. Вы указываете ей на уже имеющуюся у вас установку Modern Warfare 2, и она загружает данные этой игры в собственный независимый движок, используя дисковые форматы, восстановленные реверс-инжинирингом.
Это мод для розничной игры или совершенно новый движок?Это движок/среда исполнения с нуля, а не патч к оригинальным бинарникам. Он читает файлы ассетов MW2, но независимо заново реализует рендеринг, симуляцию и сеть; розничные протоколы, оригинальный ABI и пропатченные исполняемые файлы прямо заявлены вне области проекта.
Как собрать и запустить его?Установите системные пакеты ОС из docs/BUILD.md (компилятор, ALSA, udev, заголовки X11/Wayland на Linux; command line tools Xcode на macOS), затем соберите с профилем разработки profile.play для повседневных запусков или PROFILE=release для релизного бинарника. Портативная сборка Windows описана в docs/WINDOWS.md.
Нужно ли уже владеть Modern Warfare 2, чтобы этим пользоваться?Да — направьте переменную IW4LGAMES на папку с вашей существующей установкой MW2 (или MW3/Black Ops). С самим IW4L не поставляется ни один игровой ассет, и он лишь читает эти файлы, никогда не записывая в них.
Достаточно ли это стабильно для регулярной игры?Нет — релизов ещё нет, а API, формат конфигов, кэши и сетевой протокол меняются между коммитами, так что все должны быть на одной сборке. Сетевой код использовался только для договорных плейтестов среди людей, договорившихся заранее, а не для публичных лобби.
На каких платформах он работает?Linux, macOS (через Metal посредством wgpu) и портативная сборка Windows.
Отправляет ли он сам какие-либо данные по сети?Нет — IW4L ничего не отправляет наружу. Диагностические файлы и кэши остаются на вашем диске, пока вы сами не решите приложить их к отчёту об ошибке.
Как устроена сетевая часть мультиплеера?IW4L использует собственный одноранговый UDP-протокол со своим дельта-сжатием, надёжностью доставки и сверкой состояния. Мастер-сервер на базе QUIC лишь помогает пирам находить друг друга и не ретранслирует игровой трафик.
Как обрабатываются шейдеры оригинальной игры без DirectX?Шейдерные токены D3D9 Shader Model 3 из розничной версии заранее переводятся в WGSL, так что среде исполнения никогда не нужен DirectX для рендеринга.
Кто на самом деле написал этот проект?Вся кодовая база написана LLM на основе реверс-инжиниринга оригинальных бинарников с помощью Ghidra и сверки с публичными проектами вроде OpenAssetTools, IW4x и KisakCOD.
Ассеты каких игр он может загружать?Зоны MW2 читаются нативно, а ассеты MW3 и Black Ops конвертируются в то же внутреннее промежуточное представление assetiw4.
What are similar projects?benilla, luanti, ebiten, egui, engine, muguet, tidewater, SkyCraft
Which topics is it in?udp, shader, physics, webgpu, multiplayer, game-modding, protocol, game-engine, gamedev, p2p, simulation, rendering
Creator
vladtrc
Size
10.5 MB
Stars
1.1K
Updated
CommitOct 16
Age
1mo
Commits · 90 Days