Sam SungandClaude Opus 5.5
1d1f0a2c03
Part of #41: the last of five `benilla-app` pieces. This one is everything the others did not cover: the addon harness, the settings registry, the glue screens (login, realm list, character select and create), key bindings, the minimap, nameplates, the loading screen, transports, the performance instruments, the smaller modules, the integration tests, and the UI asset files (`OptionsFrame.xml`, `benilla.toc` and the rest). Their comments are rewritten to the rule in `docs/METHOD.md`, which is what the code does and the reference fact behind it, in a line. 27,351 comment lines become 11,010. Fixes #33. Fixes #103. - **The mechanical strip.** The citations that were only a private record number go first, and each edit is shown to be a pure removal. - **Wrong facts corrected.** The rewrite corrects the comments that stated wrong facts. Among them: - The weapon trail's emissive is 0 (`0x70ca30`): the trail is a type-5 render record, so its ambient-only light term is exact. - The camera-style dropdown writes "1", "2", "0" (`UIOptionsFrame.lua:525,536,547`); several register-site addresses in the settings table are corrected. - The graphics settings are held until `RestartGx`, as in 1.12; `Fonts.xml`'s early load no longer carries a false reason. - vmangos sends a player-name invalidation after a rename (`CharacterHandler.cpp:839`), and the cinematic camera's announce packet has an empty handler there (`MiscHandler.cpp:919`). - Stock FrameXML and GlueXML line citations are checked against the stock 1.12 files, and vmangos line citations against the pinned revision. - **Deviation labels.** "Deviation:" now marks only a choice with its recorded reason. Declining to copy a reference defect is stated plainly, and so is an unbuilt behaviour or an untraced one. - **Verification.** Every file strips to identical code, apart from test literals in `login/`, `death/` and `ui_script/death_tests.rs` that now use placeholder account and character names, and `cargo fmt --check` is clean. Six second readers compared every file old against new, restored the facts the rewrite had dropped, and checked each new citation against the code, the stock files, vmangos and the reference. A second commit corrects one comment in `benilla-ui` (`unit_is_grey`: the reference's exclusion is players only). A third lowers `ui_script_wall`'s ceiling from 45 to 40: five gameplay files named `UiScript` only in comments the rewrite removed, and the ratchet asks for the number to follow. Behaviour differences the rewrite surfaced are filed as their own issues (#339 to #353 among them). String literals are untouched; they are #92. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
benilla plays the whole game: character creation, questing and professions, dungeons and raids, battlegrounds and honor, groups, guilds, trade, mail and the auction house, on the stock 1.12 interface and with your addons. It connects to a 1.12.1 server over the original protocol and reads the game's data from your own 1.12.1 install. Every file format, the network protocol and the interface engine are written from scratch, with no original client code, no third-party WoW crates and no bundled game assets.
What's inside
- Formats: readers for the whole asset stack (the MPQ patch chain, BLP, DBC, ADT, WDT, WDL, M2 and WMO), wired into Bevy as an asset source.
- World: terrain streamed out to the horizon, portal-culled buildings with interior lighting, doodads and ground clutter, swimmable water, sky and weather, and the client's own day/night lighting, fog and gamma.
- Models: GPU-skinned M2s with the full animation controller, particles, ribbons and the spell visuals, and characters end to end: customization, the armor composite, weapons with their enchant glows, forms, stealth and mounts.
- Movement: networked movement in both directions, the server-granted modes from slow fall to roots, a follow camera with collision, boats, zeppelins and taxi flights.
- Networking: SRP6 auth through world-session crypto and the object mirror into the ECS, covering the game from movement and chat through combat, spells, groups and raids, quests, trade, mail, the auction house and battlegrounds.
- Interface: a FrameXML and Lua engine that runs the stock 1.12 interface off your install's patch chain, and third-party 1.12 addons: Questie, pfUI, Bagnon, Bartender2 and most others run. By choice, the options window and the ESC menu follow the Classic Era client's rather than 1.12's.
- Audio: music, ambience and effects under the client's own selection and crossfade rules, with interior and underwater transitions and zone reverb.
The format readers and the UI engine core are plain Rust with no Bevy in them, and the world
renderer runs with no game attached. docs/MAP.md maps every crate and subsystem,
generated from the code.
Status
Complete and fully playable. What is left:
- The long tail of small features that separates a working client from a finished one, tracked as issues.
- Addons, options and performance, ongoing.
benilla is a faithful 1.12.1 client and the foundation people build on. There are no prebuilt downloads: a packaged build, a particular server's changes or anything 1.12.1 never had belongs in a fork, and forks are welcome. GitHub lists every public fork.
Not planned: other expansions or client versions, Warden (anticheat).
Running it
benilla builds and runs on macOS, Linux and Windows. You need:
- An English 1.12.1 client (build 5875) for the game data. benilla only reads it.
- A 1.12.1 server with Warden off. vmangos is what development runs against, and it ships with Warden off; cMaNGOS and the other 1.12.1 cores speak the same protocol.
- Stable Rust and a C compiler, because the client's Lua is built from source: on macOS the Xcode command line tools, on Linux the ALSA and udev development packages and pkg-config, on Windows the MSVC build tools that the Rust installer sets up.
WOW_DATA=/path/to/WoW/Data cargo run --release -p benilla
WOW_DATA names the install's Data folder; a link to the install named WoW at the repo root
does the same. The server defaults to localhost:3724, the stock auth port. Point WOW_HOST at
another (WOW_HOST=play.example.com, or play.example.com:5000 for a remapped port), or set it
from the Realmlist button on the login screen, which remembers it. Credentials go in at the login
screen, or set WOW_USER and WOW_PASS to skip it.
Settings, screenshots and addons live in benilla-config/ at the repo root: a 1.12 addon goes in
benilla-config/AddOns/. docs/CONTRIBUTING.md has the rest, from the
player build to the tests.
Contributing
Issues and pull requests are open. docs/CONTRIBUTING.md says what gets
in and how a change is judged. Bugs, questions and ideas are welcome on the
Discord too.
Early inspiration and file format guidance came from the wowemulation-dev community, and warcraft-rs in particular.
benilla is an independent fan project, not affiliated with or endorsed by Blizzard Entertainment.
It ships no Blizzard content: no art, models, sounds, maps, MPQ contents or FrameXML. You
provide your own legally obtained 1.12.1 client, and the stock interface runs off its FrameXML at
runtime. The few files under crates/benilla-app/assets/ui/ are our own, not copies of it:
adapters over stock files, and the settings windows and script error log benilla draws itself.
World of Warcraft is a trademark of Blizzard Entertainment, Inc. Our own code is licensed under
MIT or Apache 2.0, at your option. The two vendored components
under third_party/, the kira audio engine and a Lua 5.1 patched to the 1.12 client's dialect,
keep their own upstream licenses, alongside each.