Add RotW support #8 by feored · Pull Request #9 · feored/halbu

feored · 2026-03-14T12:26:46Z

Added support for multiple versions by splitting the model into FormatId (layout)/GameEdition (family)/ExpansionType (mode), with v99/v105 expansion handling done differently on purpose.
Added blocking encode compatibility rules for known bad conversions, with an explicit opt-out (CompatibilityChecks::Ignore).
Unified the core API around one path: Save::parse / Save::summarize / save.check_compatibility / save.encode_for.
Added coverage and docs to match: new v105 fixtures, golden/compat/summary tests, updated README/examples, and bumped crate version to 0.2.0.

Bitfield implementation

Read and write skills.

…nctions.

Basic save file parsing (npcs/items placeholders)

Add serde serialization and reorganize tests/consts files.

Add getters/setters checking for bounds in attributes.

…tion bugfix. When all stats are written, parse one more attribute header to make sure we update byte_position with the position after the 0x1FF trailer.

…nt some encodes

Copilot

Pull request overview

Adds RotW (v105) support alongside legacy (v99) by introducing a format/layout abstraction, compatibility rules, and placeholder section models, plus updated docs/examples and new fixtures/tests.

Changes:

Introduce format module with layout detection, decode/encode orchestration, summarize API, and compatibility enforcement/override.
Split/modernize section models (character v99/v105 codecs, attributes bitstream, skills with D2R name mapping, waypoints, NPC/items placeholders).
Add fixtures + golden/compat/summary tests, update docs/examples, and bump crate metadata/version.

Reviewed changes

Copilot reviewed 44 out of 51 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
tests/save_format_golden.rs	Golden + compatibility + forced-encode tests across v99/v105.
src/waypoints/tests.rs	New waypoint tests (currently do not compile as written).
src/waypoints/mod.rs	New waypoint model + parsing/encoding logic.
src/waypoints/consts.rs	Waypoint section constants and waypoint name tables.
src/waypoints.rs	Removed legacy waypoint section builder.
src/utils.rs	New shared byte/bit utilities (`read_bits`/`write_bits`, endian helpers).
src/skills/tests.rs	New skills parsing + name-mapping tests (includes Warlock mapping).
src/skills/named_d2r.rs	D2R skill-name tables + normalized lookup helpers.
src/skills/mod.rs	Skills section model + raw and named APIs.
src/skills.rs	(Context only) legacy file likely replaced by module.
src/quests.rs	Removed legacy quests placeholder.
src/npcs/mod.rs	New NPC section placeholder preserving fixed-size raw payload.
src/npcs.rs	Removed legacy NPC section builder.
src/items/mod.rs	New items placeholder + empty-inventory trailer generation by layout/mode.
src/header/mod.rs	Removed legacy header code.
src/header/mercenary.rs	Removed legacy mercenary variant tables (replaced by simpler model).
src/header/character.rs	Removed legacy character code (replaced by codecs).
src/format/tests.rs	New format/layout/summary/encoding tests.
src/format/summary.rs	New fast summary extraction (header + character fields).
src/format/mod.rs	New format module wiring/re-exports.
src/format/layout.rs	Layout metadata (offsets/ranges), format detection/fallback, checksum metadata.
src/format/encode.rs	Unified encode pipeline with compatibility checks and placeholder section handling.
src/format/decode.rs	Unified decode pipeline with strict/lax issues, section parsing, checksum metadata.
src/format/compatibility.rs	Compatibility issue reporting and blocking encode validation.
src/character/v99.rs	v99 character codec (decode/encode with raw preservation).
src/character/v105.rs	v105 character codec (mode marker + raw preservation).
src/character/tests.rs	Character codec/unit tests incl. v105 fixtures + title mapping.
src/character/mod.rs	Character model, status bitfield, title helpers, canonical invariants.
src/character/mercenary/tests.rs	Mercenary parse/write tests.
src/character/mercenary/mod.rs	Mercenary model + parse/write helpers.
src/character/common.rs	Shared character codec read/write helpers with bounds errors.
src/character/codec.rs	Format-dispatched character codec entrypoints.
src/attributes/tests.rs	Updated attributes tests targeting new bitstream utilities/types.
src/attributes/mod.rs	New typed attributes model + packed bitstream parse/encode (Q8 helpers).
src/attributes.rs	Removed legacy attributes implementation.
rustfmt.toml	Expand formatting heuristics configuration.
notes.md	Removed older notes (replaced by NOTES.md).
examples/inspect_issues.rs	Example for strict vs lax parsing and issue inspection.
examples/edit_character.rs	Example editing a save and encoding back with compatibility enforcement.
assets/test/barbrotw_v105.d2s	New v105 RotW fixture.
assets/test/barbexp_v105.d2s	New v105 expansion fixture.
assets/test/barbclassic_v105.d2s	New v105 classic fixture.
assets/test/Warlock_v105.d2s	New v105 Warlock fixture.
assets/test/Test.d2s	Added/updated test fixture.
assets/test/Joe.d2s	Added/updated v99 fixture.
README.md	New/updated README with API usage and compatibility notes.
NOTES.md	New consolidated reverse-engineering notes.
LICENSE	Add MIT license file.
Cargo.toml	Bump to 0.2.0 and add package metadata/deps (serde/log/etc.).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

src/waypoints/tests.rs

+        assert_eq!(
+            parsed_waypoints.hell.act1[8],
+            WaypointInfo {
+                id: Waypoint::Catacombs,
+                name: "Catacombs",
+                act: Act::Act1,
+                acquired: true
+            }


src/waypoints/tests.rs

+    fn generate_waypoints_test() {
+        let expected_bytes: [u8; 81] = [
+            0x57, 0x53, 0x01, 0x00, 0x00, 0x00, 0x50, 0x00, 0x02, 0x01, 0x01, 0x00, 0x00, 0x00,
+            0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+            0x00, 0x00, 0x00, 0x00, 0x02, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+            0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+            0x02, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+            0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01,
+        ];
+
+        assert_eq!(expected_bytes, generate(&Waypoints::default()));
+    }


src/waypoints/mod.rs

+            _ => Err(ParseHardError {
+                message: format!("Cannot convert ID > 8 to waypoint: {id:?}"),
+            }),


src/format/decode.rs

+        }
+    }
+
+    let skills_offset = selected_layout.attributes_offset() + byte_position.current_byte + 1;


src/format/encode.rs

+fn empty_items_layout_for_encode(target: FormatId, mode_marker: u8) -> items::EmptyLayout {
+    match target {
+        FormatId::V99 => items::EmptyLayout::LegacyExpansion,
+        FormatId::V105 | FormatId::Unknown(_) => match mode_marker {
+            crate::character::v105::MODE_CLASSIC => items::EmptyLayout::V105Classic,
+            crate::character::v105::MODE_ROTW => items::EmptyLayout::V105RotW,
+            _ => items::EmptyLayout::V105Expansion,
+        },


src/skills/mod.rs

+    /// Set skill value by raw class-local index.
+    pub fn set(&mut self, skill_index: usize, value: u8) {
+        self.points[skill_index] = value;
+    }
+
+    /// Get skill value by raw class-local index.
+    pub fn get(&self, skill_index: usize) -> u8 {
+        self.points[skill_index]
+    }


src/waypoints/tests.rs

+        let parsed_waypoints = match parse(&bytes) {
+            Ok(res) => res,
+            Err(e) => panic!("parse_waypoints_test: {0}", e),
+        };


Copilot

Pull request overview

This PR adds “RotW” (v105) support and consolidates the crate’s save parsing/encoding around a unified format/layout abstraction, with explicit compatibility checks for unsafe conversions.

Changes:

Introduces FormatId (v99/v105/Unknown) layout detection + encode/decode/summarize orchestration under src/format/.
Adds new modeled sections (waypoints, skills, NPC/items placeholders) plus shared bit/byte utilities.
Adds fixtures, golden/compat/summary tests, and updates docs/examples; bumps crate metadata/version.

Reviewed changes

Copilot reviewed 46 out of 53 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tests/save_format_golden.rs	Golden roundtrip + compatibility blocker tests (v99/v105/RotW)
src/waypoints/mod.rs	New waypoint model with parse/encode + per-act APIs and errors
src/waypoints/consts.rs	Waypoint section constants + waypoint name tables
src/waypoints/tests.rs	Waypoints parse/roundtrip/unit tests
src/waypoints.rs	Removes old waypoint section builder
src/utils.rs	Adds shared parsing/bitstream read/write utilities + tests
src/skills/mod.rs	New skills section model + D2R name-based helpers
src/skills/named_d2r.rs	Default D2R skill name tables + normalized lookup
src/skills/tests.rs	Skills section/unit tests (incl. Warlock names)
src/quests.rs	Removes old quest section builder (replaced by new quests module elsewhere)
src/npcs/mod.rs	NPC section placeholder model with header validation
src/npcs.rs	Removes old NPC section builder
src/items/mod.rs	Items placeholder + empty-trailer generation by layout/mode
src/format/mod.rs	New format orchestration module exports
src/format/layout.rs	Layout metadata + `FormatId` + fallback logic
src/format/decode.rs	Unified decode path with strict/lax issues
src/format/encode.rs	Unified encode path with compatibility enforcement + checksum
src/format/summary.rs	Fast summary extraction (header + character only)
src/format/compatibility.rs	Encode compatibility rules + blocker aggregation
src/format/edition_hint.rs	Heuristic edition hint detection for unknown versions
src/format/tests.rs	Format/layout/summary/encode behavioral tests
src/character/mod.rs	New character model + title rules + status bits
src/character/codec.rs	Per-format character codec dispatch
src/character/common.rs	Shared character field read/write helpers
src/character/v99.rs	v99 character codec implementation
src/character/v105.rs	v105 character codec + mode marker handling
src/character/tests.rs	Character codec/title tests incl. v105 fixture
src/character/mercenary/mod.rs	Mercenary model parse/write helpers
src/character/mercenary/tests.rs	Mercenary unit tests
src/attributes/mod.rs	Attributes model + bitstream parse/encode + typed ids
src/attributes/tests.rs	Attributes read/write tests + utils integration
examples/waypoints.rs	Example: reading/writing waypoints with explicit errors
examples/inspect_issues.rs	Example: strict vs lax parsing + issue reporting
examples/edit_character.rs	Example: editing a save and re-encoding with compatibility checks
assets/test/*.d2s	Adds/updates v105 fixtures + additional test saves
README.md	Updated docs, API usage, compatibility/edition hint explanation
NOTES.md	Consolidated/updated format reverse-engineering notes
notes.md	Removes old notes file (replaced by NOTES.md)
rustfmt.toml	Formatting heuristics update
Cargo.toml	Crate metadata updates + version bump + new deps
LICENSE	Adds MIT license file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

src/skills/mod.rs

+    /// Set skill value by raw class-local index.
+    pub fn set(&mut self, skill_index: usize, value: u8) {
+        self.points[skill_index] = value;
+    }
+
+    /// Get skill value by raw class-local index.
+    pub fn get(&self, skill_index: usize) -> u8 {
+        self.points[skill_index]
+    }


src/format/layout.rs

+pub(crate) fn layout_for_encode(target: FormatId) -> &'static dyn Layout {
+    match target {
+        FormatId::V99 => &V99_LAYOUT,
+        FormatId::V105 | FormatId::Unknown(_) => &V105_LAYOUT,
+    }


src/waypoints/consts.rs

+pub const SECTION_HEADER: [u8; 8] = [0x57, 0x53, 0x01, 0x00, 0x00, 0x00, 0x50, 0x00];
+pub const DIFFICULTY_HEADER: [u8; 2] = [0x02, 0x01];
+pub const SECTION_TRAILER: u8 = 0x01;


src/skills/named_d2r.rs

+    let class_skills = d2r_skills_for_class(class)?;
+    class_skills
+        .iter()
+        .position(|candidate| normalize_name(candidate) == normalized_query)
+        .ok_or(NamedSkillError::UnknownSkillName { class, skill_name: skill_name.to_string() })
+}


feored added 30 commits July 22, 2023 21:23

Merge pull request #1 from feored/bitfield-implementation

af0bc61

Bitfield implementation

Read and write skills.

9134f63

Merge pull request #2 from feored/skills

8037014

Read and write skills.

Mercenary writing and parsing

5b99366

Parse character information in header.

cf9a4b9

Implement interfaces for parsing quests and add u16_from, u32_from fu…

e8047a5

…nctions.

Parse and generate quest sections

c7a191c

Parse and generate waypoints

962cdd9

Character generation.

5932bda

Prototype of full save file parsing.

e69f6d0

First draft generating save

3b9d084

Fix npcs/items placeholders, generated level 1 character

b9d45e9

Merge pull request #3 from feored/dev

72602c2

Basic save file parsing (npcs/items placeholders)

Move tests and consts into their own files

a04cabc

Reorganize file structure

83def21

Fix file organization

7da756d

Add serde serialization/deserialization trait

2f6ef15

Merge pull request #4 from feored/dev

414dc36

Add serde serialization and reorganize tests/consts files.

Add getters/setters checking for bounds in attributes.

1963455

Merge pull request #5 from feored/dev

e665ffd

Add getters/setters checking for bounds in attributes.

Add level validation and default(class) fn for character/attributes.

317137f

Use newtype pattern to validate level, experience, attribute.

56b019a

Make character name its own struct for validation.

fbdf4fc

Change rustfmt rules and add unicode segmentation package.

86d2e0d

Revert to using placeholder for items, notes on mercenary levels.

9158aeb

Fix act 5 quests bug + add note concerning mercenary levels

3bb3f9a

Add math for mercenary level/xp calculations.

5e25257

Make mercenary variant a tuple struct.

7a53e68

Bugfix attributes parsing when all stats are written and items genera…

5b3ba03

…tion bugfix. When all stats are written, parse one more attribute header to make sure we update byte_position with the position after the 0x1FF trailer.

Fix items placeholder if merc is hired.

bff5d0b

feored added 19 commits June 28, 2025 09:11

Update README.md

3014a32

Update README.md

69e1d36

Update README.md

72bfd1e

rotw support

98dca2f

Merge branch 'main' of https://github.com/feored/halbu

1656675

tests v99/v105 coverage

2ccefef

add warlock skills, add back named skills + better tests and readme

27652b6

fix readme

47bd9ae

bump version to 0.2.0 and update deps

d4f163e

v105 expansion type

717644f

different expansion handling in v99/v105

6150c2a

separate properly concept of format/game edition/expansion, and preve…

736f22a

…nt some encodes

add save summary

ade7e3a

add to_bytes_for_force and centralize class/edition compatibility

2f3c683

expose checksum in parsedsave

45b283e

expose checksum in parsed save

aa58ef3

update readme

e31774b

code/docs cleanup

956c694

add compatibility rules to readme

ef2af8a

feored requested a review from Copilot March 14, 2026 12:27

Copilot started reviewing on behalf of feored March 14, 2026 12:27 View session

Copilot AI reviewed Mar 14, 2026

View reviewed changes

feored added 3 commits March 14, 2026 14:34

refactor waypoints

222dc8f

add waypoint usage example

3c5f722

add module to try and guess save game edition

a539b36

feored requested a review from Copilot March 15, 2026 06:42

Copilot started reviewing on behalf of feored March 15, 2026 06:43 View session

Copilot AI reviewed Mar 15, 2026

View reviewed changes

feored added 2 commits March 15, 2026 08:11

reject encodes to unknown and various other fixes

a0a51d6

expose detected + decoded save layout

f6c76e1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RotW support #8#9

Add RotW support #8#9
feored wants to merge 79 commits intomainfrom
dev

feored commented Mar 14, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

feored commented Mar 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants