ProfanityFE

A curses-based terminal frontend for DragonRealms and GemStone IV, connecting through a local game proxy such as Lich.

Features

• Multi-window layouts (story, combat, death, thoughts, room, spells, etc.)
• Color highlighting with configurable regex patterns
• Countdown timers for roundtime/casttime/stun
• Progress bars for health, mana, stamina, stance, encumbrance
• Clickable in-game links (directions, objects, players)
• Tabbed text windows with per-tab activity indicators
• Dedicated room window with creature highlighting
• Experience tracking window
• Active spell display with duration sorting
• Gag patterns for filtering unwanted text
• Emacs-style kill ring and command history
• Mouse scroll wheel support
• Macro engine with key bindings

Quick Start

git clone https://github.com/elanthia-online/ProfanityFE.git
cd ProfanityFE
bundle install
ruby profanity.rb --port=8000 --char=YourCharacter

Documentation

See the User Guide for full documentation including settings XML reference, layout configuration, key bindings, and troubleshooting.

Dependencies

• Ruby 4.0+
• Gems to run the client:
  • curses (~> 1.4)
  • rexml (~> 3.4)
• Gems for development (the test group):
  • rspec (~> 3.13): the test suite
  • rubocop (~> 1.75): style checks; CI runs the version locked in Gemfile.lock
  • yard (~> 0.9): API documentation; CI fails on YARD warnings, on any undocumented object (private methods included), and on YARD tags that don't match the code (see below)

Install all dependencies with bundle install, or only the ones needed to run the client with bundle config set --local without test && bundle install.

To run the YARD checks CI runs:

bundle exec yard doc --private --fail-on-warning --no-save --no-stats --output-dir /tmp/yard
bundle exec yard stats --private --list-undoc --no-save  # must not list "Undocumented Objects:"
bundle exec ruby script/check_yard_tags.rb

script/check_yard_tags.rb checks every method in the files listed in .yardopts: a typed @param for each parameter and none for a parameter it doesn't have, a @return, a @yield or @yieldparam if it yields, and a @raise if it raises. It prints each gap as file:line Path: gap and exits 1 if there is any. Pass file names to check only those files, or --self-test to check the checker.

Terminal

Run with TERM=xterm-256color, or tmux-256color from a current ncurses terminfo (e.g. ncurses 6.x on Linux). Ctrl and Alt combinations with arrows, Delete or Page Up/Down need terminfo support: under screen-256color, or macOS's tmux-256color, Alt+PageUp/PageDown type characters into the command line instead.

• GNU Screen: term xterm-256color in .screenrc
• tmux: set -g default-terminal "tmux-256color" in .tmux.conf, with a terminfo that has the extended keys (infocmp -x tmux-256color | grep kNXT3 prints a match)

See Modifier combinations in the User Guide.

License

Licensed under the GNU General Public License v2.0. See profanity.rb header for details.