aethyr/Aethyr
2
0
Fork 0
Code Issues 281 Pull requests Projects Releases Packages Wiki Activity Actions

Allow non-ncurses clients #11

New issue
Open
opened 2019-04-17 10:06:24 +00:00 by freemo · 0 comments
freemo commented 2019-04-17 10:06:24 +00:00 (Migrated from git.qoto.org)
Copy link

Metadata

  • Commit Message: feat(display): support non-ncurses plain-text clients
  • Branch: feature/m2-non-ncurses-clients

Background and Context

The server currently renders all output using server-side Ncurses window management. Clients that do not support the Ncurses escape sequences (e.g., simple telnet clients, web-based MUD clients) receive garbled output. A fallback plain-text rendering mode is needed for these clients.

Expected Behavior

The server detects whether a client supports Ncurses-style rendering (via TTYPE negotiation or a configuration flag). Clients that do not support it receive plain-text output with basic ANSI colors but without window management escape sequences.

Acceptance Criteria

  • Server detects non-Ncurses clients via TTYPE negotiation
  • Non-Ncurses clients receive plain-text output without window management escapes
  • Basic ANSI color codes are still sent to non-Ncurses clients
  • All game functionality works for non-Ncurses clients (commands, combat, maps rendered as ASCII text)
  • Players can manually toggle between Ncurses and plain-text modes

Subtasks

  • Code: Add a rendering_mode attribute to PlayerConnection (:ncurses or :plain)
  • Code: Detect client capabilities during TTYPE negotiation — set :plain for unrecognized terminal types
  • Code: Implement a PlainTextRenderer that formats game output as simple text with ANSI colors but no window positioning
  • Code: Route output through the appropriate renderer based on rendering_mode
  • Code: Add a player command to toggle rendering mode (e.g., set display plain / set display ncurses)
  • Code: Ensure map display falls back to basic ASCII grid for plain-text clients
  • Docs: Update YARD comments on PlayerConnection and Display classes. Document the plain-text mode in player help.
  • Tests (Cucumber): Add tests/unit/plain_text_renderer.feature covering: plain text output formatting, ANSI color inclusion, map fallback, mode detection
  • Tests (Cucumber Integration): Add integration feature verifying a plain telnet client receives readable output.
  • 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(display): support non-ncurses plain-text clients` - **Branch**: `feature/m2-non-ncurses-clients` ## Background and Context The server currently renders all output using server-side Ncurses window management. Clients that do not support the Ncurses escape sequences (e.g., simple telnet clients, web-based MUD clients) receive garbled output. A fallback plain-text rendering mode is needed for these clients. ## Expected Behavior The server detects whether a client supports Ncurses-style rendering (via TTYPE negotiation or a configuration flag). Clients that do not support it receive plain-text output with basic ANSI colors but without window management escape sequences. ## Acceptance Criteria - [ ] Server detects non-Ncurses clients via TTYPE negotiation - [ ] Non-Ncurses clients receive plain-text output without window management escapes - [ ] Basic ANSI color codes are still sent to non-Ncurses clients - [ ] All game functionality works for non-Ncurses clients (commands, combat, maps rendered as ASCII text) - [ ] Players can manually toggle between Ncurses and plain-text modes ## Subtasks - [ ] Code: Add a `rendering_mode` attribute to `PlayerConnection` (`:ncurses` or `:plain`) - [ ] Code: Detect client capabilities during TTYPE negotiation — set `:plain` for unrecognized terminal types - [ ] Code: Implement a `PlainTextRenderer` that formats game output as simple text with ANSI colors but no window positioning - [ ] Code: Route output through the appropriate renderer based on `rendering_mode` - [ ] Code: Add a player command to toggle rendering mode (e.g., `set display plain` / `set display ncurses`) - [ ] Code: Ensure map display falls back to basic ASCII grid for plain-text clients - [ ] Docs: Update YARD comments on `PlayerConnection` and `Display` classes. Document the plain-text mode in player help. - [ ] Tests (Cucumber): Add `tests/unit/plain_text_renderer.feature` covering: plain text output formatting, ANSI color inclusion, map fallback, mode detection - [ ] Tests (Cucumber Integration): Add integration feature verifying a plain telnet client receives readable output. - [ ] 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 self-assigned this 2026-03-15 04:25:21 +00:00
freemo added this to the (deleted) milestone 2026-03-15 04:25:53 +00:00
freemo modified the milestone from (deleted) to v1.1.0 2026-03-16 00:28:16 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
feature/m2-headless-renderer
dependabot/bundler/rdoc-6.3.2
dependabot/bundler/rexml-3.2.5
dependabot/bundler/json-tw-2.3
inprogress
dependabot/bundler/rake-tw-13.0
No results found.
Labels
Clear labels   
Blocked

Cannot proceed, depends on unresolved issue

  
Duplicate

Issue is a duplicate of an existing one

  
MoSCoW/Could Have

Desirable but not necessary, included if time permits

  
MoSCoW/Must Have

Essential, project cannot ship without it

  
MoSCoW/Should Have

Important but not strictly essential

  
Points/1

Estimated effort: 1 story points

  
Points/13

Estimated effort: 13 story points

  
Points/2

Estimated effort: 2 story points

  
Points/21

Estimated effort: 21 story points

  
Points/3

Estimated effort: 3 story points

  
Points/5

Estimated effort: 5 story points

  
Points/8

Estimated effort: 8 story points

  
Priority/Backlog

Not yet prioritized

  
Priority/Critical

Must be addressed immediately

  
Priority/High

Important, should be completed soon

  
Priority/Low

Nice to have, not time-sensitive

  
Priority/Medium

Normal priority, valid and should be addressed

  
State/Completed

Issue resolved and all PRs merged

  
State/In progress

Someone is actively working on this issue

  
State/In review

Implementation complete, PR submitted for review

  
State/Paused

Work temporarily suspended, typically blocked

  
State/Unverified

Issue created but not yet reviewed by a maintainer

  
State/Verified

Maintainer confirmed valid and actionable

  
State/Wont Do

Deliberate decision not to address this issue

  
Type/Bug

A defect in existing functionality

  
Type/Epic

Large body of work broken into multiple issues

  
Type/Feature

A new capability or user story

  
Type/Legendary

Major strategic pillar composed of multiple Epics

  
Type/Task

Technical or administrative work (not bug or feature)

  
Type/Testing

Test-only work item (TDD, test infrastructure, coverage)

No labels
Blocked
Duplicate
MoSCoW/Could Have
MoSCoW/Must Have
MoSCoW/Should Have
Points/1
Points/13
Points/2
Points/21
Points/3
Points/5
Points/8
Priority/Backlog
Priority/Critical
Priority/High
Priority/Low
Priority/Medium
State/Completed
State/In progress
State/In review
State/Paused
State/Unverified
State/Verified
State/Wont Do
Type/Bug
Type/Epic
Type/Feature
Type/Legendary
Type/Task
Type/Testing
Milestone
Clear milestone
No items
No milestone
v1.1.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
freemo
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.

Blocks
#311 Epic: Display & Format Bug Fixes
aethyr/Aethyr
Reference: aethyr/Aethyr#11
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?