Add FOREST, OCEAN, DESERT terrain types to terrain.rb #52

Open
opened 2026-03-14 23:57:22 +00:00 by freemo · 0 comments
Owner

Metadata

  • Commit Message: feat(worldgen): add forest, ocean, desert terrain types
  • Branch: feature/m3-terrain-types

Background and Context

The terrain type system in lib/aethyr/core/objects/info/terrain.rb currently defines GRASSLAND, CITY, TOWN, TUNDRA, and UNDERGROUND terrain types. The specification requires FOREST, OCEAN, and DESERT terrain types to complete the terrain system and enable proper mapping from ESA WorldCover satellite land-cover classification codes.

Expected Behavior

Three new terrain type constants are defined in terrain.rb with appropriate room text, area text, and ESA WorldCover code mappings:

  • FOREST: "forest" / "dense forest" — codes 10 (tree cover), 20 (shrubland)
  • OCEAN: "ocean" / "open water" — code 80 (permanent water bodies)
  • DESERT: "desert" / "arid wasteland" — code 60 (bare/sparse vegetation)

Acceptance Criteria

  • FOREST, OCEAN, and DESERT constants exist in the terrain type module
  • Each terrain type has room text and area text descriptors per specification
  • ESA WorldCover code-to-terrain mappings are updated in the module
  • Existing terrain types (GRASSLAND, CITY, etc.) are unaffected

Subtasks

  • Code: Add FOREST constant with room_text "forest", area_text "dense forest" to lib/aethyr/core/objects/info/terrain.rb
  • Code: Add OCEAN constant with room_text "ocean", area_text "open water" to lib/aethyr/core/objects/info/terrain.rb
  • Code: Add DESERT constant with room_text "desert", area_text "arid wasteland" to lib/aethyr/core/objects/info/terrain.rb
  • Code: Update the ESA WorldCover code mapping (if a code-to-terrain hash exists) to include: 10/20 -> FOREST, 60 -> DESERT, 80 -> OCEAN
  • Docs: Update RDoc comments on the terrain type module to document new constants
  • Docs: Verify the Docusaurus documentation references to terrain types are consistent with the specification
  • Tests (Cucumber): Add tests/unit/terrain_types.feature covering: each new terrain type exists with correct attributes, code-to-terrain mapping returns correct types for ESA codes 10, 20, 60, 80
  • Tests (Cucumber Integration): Add integration feature in tests/integration/ verifying terrain types render correctly in room descriptions
  • Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions for terrain operations
  • Quality: Verify coverage >=85% via bundle exec rake unit. If coverage is <85% 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 >=85%. Only mark this as complete once coverage is >=85%, if not repeat this task as many times as is needed until coverage reaches >=85%.
  • 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(worldgen): add forest, ocean, desert terrain types` - **Branch**: `feature/m3-terrain-types` ## Background and Context The terrain type system in `lib/aethyr/core/objects/info/terrain.rb` currently defines GRASSLAND, CITY, TOWN, TUNDRA, and UNDERGROUND terrain types. The specification requires FOREST, OCEAN, and DESERT terrain types to complete the terrain system and enable proper mapping from ESA WorldCover satellite land-cover classification codes. ## Expected Behavior Three new terrain type constants are defined in `terrain.rb` with appropriate room text, area text, and ESA WorldCover code mappings: - FOREST: "forest" / "dense forest" — codes 10 (tree cover), 20 (shrubland) - OCEAN: "ocean" / "open water" — code 80 (permanent water bodies) - DESERT: "desert" / "arid wasteland" — code 60 (bare/sparse vegetation) ## Acceptance Criteria - [ ] FOREST, OCEAN, and DESERT constants exist in the terrain type module - [ ] Each terrain type has room text and area text descriptors per specification - [ ] ESA WorldCover code-to-terrain mappings are updated in the module - [ ] Existing terrain types (GRASSLAND, CITY, etc.) are unaffected ## Subtasks - [ ] Code: Add FOREST constant with room_text "forest", area_text "dense forest" to `lib/aethyr/core/objects/info/terrain.rb` - [ ] Code: Add OCEAN constant with room_text "ocean", area_text "open water" to `lib/aethyr/core/objects/info/terrain.rb` - [ ] Code: Add DESERT constant with room_text "desert", area_text "arid wasteland" to `lib/aethyr/core/objects/info/terrain.rb` - [ ] Code: Update the ESA WorldCover code mapping (if a code-to-terrain hash exists) to include: 10/20 -> FOREST, 60 -> DESERT, 80 -> OCEAN - [ ] Docs: Update RDoc comments on the terrain type module to document new constants - [ ] Docs: Verify the Docusaurus documentation references to terrain types are consistent with the specification - [ ] Tests (Cucumber): Add `tests/unit/terrain_types.feature` covering: each new terrain type exists with correct attributes, code-to-terrain mapping returns correct types for ESA codes 10, 20, 60, 80 - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` verifying terrain types render correctly in room descriptions - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions for terrain operations - [ ] Quality: Verify coverage >=85% via `bundle exec rake unit`. If coverage is <85% 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 >=85%. Only mark this as complete once coverage is >=85%, if not repeat this task as many times as is needed until coverage reaches >=85%. - [ ] 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.1.0 milestone 2026-03-14 23:57:22 +00:00
freemo self-assigned this 2026-03-15 04:25:22 +00:00
freemo modified the milestone from v1.1.0 to v1.2.0 2026-03-16 00:28: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#52
No description provided.