Implement automatic weapon configuration detection from player equipment state #259

Open
opened 2026-03-16 01:50:08 +00:00 by freemo · 0 comments
Owner

Metadata

  • Commit Message: feat(combat): implement automatic weapon configuration detection
  • Branch: feature/m4-weapon-config-detect

Background and Context

When combat begins, the system must examine the player's equipment (wielded items) to determine which of the 7 weapon configurations applies. This detection runs at combat start and whenever equipment changes during combat.

Expected Behavior

WeaponConfigDetector.detect(player) examines the player's wielded items and returns the appropriate configuration symbol. Two-handed weapons are identified by a two_handed flag. Shields are identified by the Armor class with a shield flag.

Acceptance Criteria

  • Correctly identifies all 7 configurations based on equipment state
  • Two-handed detection uses weapon's two_handed attribute
  • Shield detection uses armor's shield attribute
  • Empty hands detected as :unarmed configuration
  • Configuration updates mid-combat when equipment changes (e.g., weapon dropped)

Subtasks

  • Code: Create WeaponConfigDetector module with detect(player) class method
  • Code: Add two_handed attribute to Weapon class for two-handed weapon identification
  • Code: Add shield attribute to Armor class for shield identification
  • Code: Implement detection logic: check right_hand and left_hand wielded items, classify into one of 7 configs
  • Code: Integrate detection with HandTracker — call on combat start and on equipment change events
  • Docs: Update YARD comments on affected classes and methods. Update relevant Docusaurus documentation pages if applicable.
  • Tests (Cucumber): Add tests/unit/weapon_config_detect.feature covering each of 7 configurations detected correctly from equipment state.
  • Tests (Cucumber Integration): Add integration feature in tests/integration/ for weapon configuration detection on combat entry.
  • Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions.
  • Quality: Verify coverage >=97% via bundle exec rake unit. If coverage is <97% then review the current unit test coverage report at build/tests/unit/coverage/ and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun bundle exec rake unit to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%.
  • Quality: Run bundle exec rake (default task: unit tests with coverage) and bundle exec rake integration, fix any errors if needed ensuring both pass across entire code base, do not ignore any failure even if it seems unrelated to this commit, fix it.

Definition of Done

This issue is complete when:

  • All subtasks above are completed and checked off.
  • A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
  • The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
  • The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.
## Metadata - **Commit Message**: `feat(combat): implement automatic weapon configuration detection` - **Branch**: `feature/m4-weapon-config-detect` ## Background and Context When combat begins, the system must examine the player's equipment (wielded items) to determine which of the 7 weapon configurations applies. This detection runs at combat start and whenever equipment changes during combat. ## Expected Behavior `WeaponConfigDetector.detect(player)` examines the player's wielded items and returns the appropriate configuration symbol. Two-handed weapons are identified by a `two_handed` flag. Shields are identified by the Armor class with a `shield` flag. ## Acceptance Criteria - [ ] Correctly identifies all 7 configurations based on equipment state - [ ] Two-handed detection uses weapon's `two_handed` attribute - [ ] Shield detection uses armor's `shield` attribute - [ ] Empty hands detected as `:unarmed` configuration - [ ] Configuration updates mid-combat when equipment changes (e.g., weapon dropped) ## Subtasks - [ ] Code: Create `WeaponConfigDetector` module with `detect(player)` class method - [ ] Code: Add `two_handed` attribute to Weapon class for two-handed weapon identification - [ ] Code: Add `shield` attribute to Armor class for shield identification - [ ] Code: Implement detection logic: check right_hand and left_hand wielded items, classify into one of 7 configs - [ ] Code: Integrate detection with HandTracker — call on combat start and on equipment change events - [ ] Docs: Update YARD comments on affected classes and methods. Update relevant Docusaurus documentation pages if applicable. - [ ] Tests (Cucumber): Add `tests/unit/weapon_config_detect.feature` covering each of 7 configurations detected correctly from equipment state. - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` for weapon configuration detection on combat entry. - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions. - [ ] Quality: Verify coverage >=97% via `bundle exec rake unit`. If coverage is <97% then review the current unit test coverage report at `build/tests/unit/coverage/` and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `bundle exec rake unit` to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%. - [ ] Quality: Run `bundle exec rake` (default task: unit tests with coverage) and `bundle exec rake integration`, fix any errors if needed ensuring both pass across **entire** code base, do not ignore any failure even if it seems unrelated to this commit, fix it. ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done.
freemo added this to the v1.3.0 milestone 2026-03-16 01:50:08 +00:00
freemo self-assigned this 2026-03-16 01:50:08 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference: aethyr/Aethyr#259
No description provided.