rebase to current master branch

.gitattributes

@@ -0,0 +1,4 @@
+.git*           export-ignore
+*.yml           export-ignore
+README.md       export-ignore
+Gemfile*        export-ignore

.github/workflows/rubocop.yml

@@ -0,0 +1,47 @@
+name: Rubocop
+on: 
+  push:
+    paths:
+      - "**/*.rb"
+      - "profanity.rb"
+  pull_request:
+    paths:
+      - "**/*.rb"
+      - "profanity.rb"
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.3']
+    name: Run Rubocop on Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v44
+        with:
+          files: |
+            **/*.rb
+            profanity.rb
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: false
+      - name: Install ruby gem dependencies with bundler
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - run: bundle install
+      - name: Rubocop
+        run: |
+          for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
+            bundle exec rubocop $file
+          done

.rubocop.yml

@@ -0,0 +1,69 @@
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: disable
+  Include:
+    - '**/*.lic'
+    - '**/*.rb'
+
+Naming:
+  Enabled: false
+
+Style:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/EndOfLine:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Layout/ClosingHeredocIndentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Security/Eval:
+  Enabled: false
+
+Security/MarshalLoad:
+  Enabled: false
+
+Lint/ScriptPermission:
+  Enabled: false

Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+group :development do
+  gem "rspec"
+  gem 'rubocop'
+end

README.md

@@ -1,4 +1,83 @@
-ProfanityFE
-===========
-
+# ProfanityFE
 A terminal frontend for Simutronics games based on Ruby and Ncurses.
+
+## Installation
+1. Install Ruby on machine
+2. Git Clone the Lich5 repository
+3. Git Clone the ProfanityFE repository
+4. Configure the template file for your character in the ProfanityFE\templates folder, otherwise use default.xml
+5. Open Lich5 and save a character entry, alternatively do this on another machine with a GUI interface and copy Lich5\data\entry.dat
+6. Launch Lich5 via `ruby ~/lich-5/lich.rbw --login Rinualdo --without-frontend --detachable-client=8000 &` or similar.
+7. Launch Profanity via `ruby ~/ProfanityFE/profanity.rb --port=8000 --char=Rinualdo`
+
+## Profanity CLI Options
+* --port=<port>
+* --default-color-id=<id>
+* --default-background-color-id=<id>
+* --custom-colors=<on|off>
+* --settings-file=<filename>
+* --char=<character>
+* --no-status                           do not redraw the process title with status updates
+* --links                               enable links to be shown by default, otherwise can enable via .links command
+* --speech-ts                           display timestamps on speech, familiar and thought window
+* --remote-url                          display LaunchURLs on screen, used for remote environments
+* --template=<filename.xml>             filename of template to use in templates subdirectory
+
+## Sample Scripts
+Here's a sample login script written for Linux, usage syntax would be `.\gemstone.sh <CHARNAME>`
+
+Do note that some of these settings will need to be adjusted based on the terminal being used (e.g. xterm-256color vs screen-256color)
+```bash
+#!/bin/bash
+set -e
+
+port=8000
+CHAR=$1
+LICH_BIN=~/lich-5/lich.rbw
+PROFANITY_BIN=~/ProfanityFE/profanity.rb
+
+export TERM=screen-256color
+
+lookup_char_port () {
+  local char=$1
+  port=$(ps a | egrep -0 "\-\-login $char \-\-detachable-client=([0-9]+)" | egrep -o "[0-9]+" | sort | tail -n1)
+}
+
+if [[ -z $CHAR ]]; then
+  echo "Usage: gemstone.sh {{character_name}}"
+  exit
+fi
+
+if [[ -z $DISPLAY ]]; then
+  echo "Detected empty DISPLAY setting, defaulting to :0"
+fi
+
+echo "Attempting to login as $CHAR..."
+
+if ps aux | \grep [l]ich | \grep -i $CHAR; then
+  lookup_char_port $CHAR
+  echo "Detecting existing connection on port $port"
+else
+  if ps a | \grep [d]etachable-client; then
+    max_port=$(ps a | grep -Eo "\-\-detachable-client=([0-9]+)" | egrep -o "[0-9]+" | sort | tail -n1)
+    port=$(expr $max_port + 1)
+  fi
+  echo "Detecting existing clients but no connection for this character. Using Port[$port]"
+  echo "ruby $LICH_BIN --login $CHAR --detachable-client=$port --without-frontend 2> /dev/null &"
+
+  ruby $LICH_BIN --login $CHAR --detachable-client=$port --without-frontend 2> /dev/null &
+  sleep 4
+fi
+
+for i in {1..10}; do
+  echo "Attempting to connect to lich process... "
+  echo "ruby $PROFANITY_BIN --port=$port --char=$CHAR"
+  if ruby $PROFANITY_BIN --port=$port --char=$CHAR; then
+    echo "Done"
+    break
+  else
+    echo "Failed to establish connection, trying again in 3 seconds..."
+    sleep 3
+  fi
+done
+```

ext/string.rb

@@ -1,28 +1,28 @@
 class String
-	def alnum?
-		!!match(/^[[:alnum:]]+$/)
-	end
-  
+  def alnum?
+    !!match(/^[[:alnum:]]+$/)
+  end
+
   def digits?
-		!!match(/^[[:digit:]]+$/)
-	end
-  
+    !!match(/^[[:digit:]]+$/)
+  end
+
   def punct?
-		!!match(/^[[:punct:]]+$/)
-	end
-  
+    !!match(/^[[:punct:]]+$/)
+  end
+
   def space?
-		!!match(/^[[:space:]]+$/)
+    !!match(/^[[:space:]]+$/)
   end
-  
+
   def &(other)
-		shortest, longest = [self, other].sort { |a, b| a.size - b.size }
+    shortest, longest = [self, other].sort { |a, b| a.size - b.size }
 
-		shortest.each_char.to_a
-			.zip(longest.each_char.to_a)
-			.take_while { |a, b| a == b }
-			.transpose
-			.first
-			.join("")
-	end
-end
+    shortest.each_char.to_a
+            .zip(longest.each_char.to_a)
+            .take_while { |a, b| a == b }
+            .transpose
+            .first
+            .join("")
+  end
+end

hilite/hilite.rb

@@ -9,11 +9,11 @@ module Hilite
   def self.load(file:, flush: true)
     Hilite.fetch(file: file, flush: flush) do |xml|
       store.clear() if flush
-     
+
       xml.elements
-        .select do |ele| ele.name.eql?("highlight") end
-        .each do |highlight| Hilite.parse(highlight: highlight, parent: file) end
-        
+         .select do |ele| ele.name.eql?("highlight") end
+         .each do |highlight| Hilite.parse(highlight: highlight, parent: file) end
+
       return xml
     end
   end
@@ -26,22 +26,24 @@ def self.parse(highlight:, parent:)
   def self.inherit(file:, parent:)
     Profanity.log("[Settings] inheriting #{file} from #{parent}") if Opts.debug
     Hilite.load(
-      file:  File.join(File.dirname(parent), file),
-      flush: false)
+      file: File.join(File.dirname(parent), file),
+      flush: false
+    )
   end
 
   def self.add_highlight(highlight)
     begin
       pattern = %r{#{highlight.text.strip}}
-      Hilite.put(pattern, [ 
-        highlight.attributes["fg"], 
-        highlight.attributes["bg"], 
-        highlight.attributes["ul"]])
+      Hilite.put(pattern, [
+                   highlight.attributes["fg"],
+                   highlight.attributes["bg"],
+                   highlight.attributes["ul"]
+                 ])
     rescue => exception
       # todo: write useful error/backtrace to UI
       Profanity.log(highlight.text)
       Profanity.log(exception.message)
       Profanity.log(exception.backtrace)
     end
   end
-end
+end

layout/layout.rb

@@ -4,4 +4,4 @@
 module Layout
   extend KVStore
   extend Loader
-end
+end