rubyterm 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a2cc824f4577e989c6088109c8834f87ce4f4cc0ac665c675d491c4d41d26c
-  data.tar.gz: b1f1aec85cf6371a0849cd751fa66c2574e7000ab7ce239b732a83a4ab98e772
+  metadata.gz: eaf865731aa7f369f532b56ea31e90fc542a1d0ce88c649bd39a336614bcd446
+  data.tar.gz: 32daf9da2882ba26c505ceaecb41502a9a140005e0120c3d0036d64a3056a628
 SHA512:
-  metadata.gz: 0326e398a563a39696b46ed2c2bf0747083a73b191be8cc29ac0d691a5f7fb496954eaee316d18575dc49dc9ae38fa37e5ebf92d4f9b11c980021989eceba51c
-  data.tar.gz: 0f8ba682ebce7530c59202637ca5e2c8c103473b489c947eb86173d8ef6fb5ae0e817ffa08830a0aa9d609409aa1aaa54003793f9e8348007f45b7631e000fff
+  metadata.gz: 8d6e3a1b56ecf612e5f5f8058b0f57e030ee03159629899825cf8ea804dc32839f68cb529f10ae93bcb160dc52774a075509fdd10f6a4e12b11cc574fc57de8c
+  data.tar.gz: adcc26061be88db1f5da30f369b01f64f38e01fcb117118e37fb0581176e0b851d66305a28b3f2a2a7822ae8503e26fcdbe45c14b4d5c2657bcb3a52ea310a92

data/README.md

@@ -1,8 +1,9 @@
 # rubyterm
 
 A terminal emulator written **entirely in Ruby** — including a pure-Ruby
-X11 client to talk to the X server. There is no C extension and no libvte;
-the escape-sequence interpreter, the screen buffer, the rendering and the
+X11 client to talk to the X server and a pure-Ruby font renderer.
+
+There is no C extension and no libvte; the escape-sequence interpreter, the screen buffer, the rendering and the
 X11 protocol handling are all Ruby.
 
 It is still rough and opinionated, but it now runs as an installable gem
@@ -11,13 +12,18 @@ with a `rubyterm` executable, renders with a damage-driven pipeline
 split into a reusable terminal *engine* that can be driven without X11 at
 all.
 
-> **You probably don't want to depend on this yet.** Escape-code coverage
-> is partial (VT100/VT102 plus a useful chunk of xterm), font handling is
-> basic, and the keymap is limited. Full-screen apps mostly work; some will
+> **NOTE**: Escape-code coverage is partial (VT100/VT102 plus a useful chunk of xterm), font handling is
+> basic, and the keymap is limited. It is *slow*, though it is my main driver. Full-screen apps mostly work; some will
 > still misbehave. I have specific ideas about direction, so if you'd like
 > to contribute, **talk to me first** (vidar@hokstad.com) or fork — I won't
 > promise to merge changes we haven't discussed.
 
+## Screenshots of Ruby-in-Ruby-in-Ruby-...
+
+![Rubyterm](docs/2026-06-15_18-40_1.png)
+
+This shows Rubyterm running on my [Ruby based WM](https://github/vidarh/rubywm), running [Rubyterm with a text-based-backend](examples/) that renders a a terminal *to text* (so it can run in any terminal), running my [editor Re](https://github.com/vidarh/re) editing the Rubyterm example. The text is rendered using the pure-Ruby TrueType font renderer [Skrift](https://github.com/vidarh/re), and connected to my X11 server using the [Pure-X11](https://github.com/vidarh/ruby-x11) Ruby X11 bindings (no libX or XCB, just pure Ruby socket code).
+
 ## Architecture
 
 The code is deliberately small and split along clean seams so the pieces
@@ -51,14 +57,21 @@ For the full picture and the rationale behind the layering, see:
 
 ## Installation
 
-Dependencies are managed with Bundler; `skrift` and `skrift-x11` are
-developed alongside this project and are referenced as local path gems in
-the `Gemfile`.
+Dependencies are managed with Bundler.
 
 ```bash
 bundle install
 ```
 
+`skrift` and `skrift-x11` are developed alongside this project and are
+pulled from git. To build against a local checkout instead of the pushed
+branch, set a per-machine local override (kept out of the repo):
+
+```bash
+bundle config set --global local.skrift     /path/to/skrift
+bundle config set --global local.skrift-x11 /path/to/skrift-x11
+```
+
 ## Running
 
 ```bash
@@ -83,6 +96,10 @@ file is absent, defaults are used.
   (`"~/fonts/MyFont.ttf"`), a file in `~/.local/share/fonts/`, or a name
   resolved via `fc-match` (`"monospace"`, `"monospace:weight=bold"`).
 - **`fontsize`** — font size in points (e.g. `fontsize = 24`).
+- **`width`** / **`height`** — initial window size in pixels; the terminal
+  grid is derived from it and the font cell size. Defaults to `1000 x 600`
+  (~80×24 at the default font); on a big display, e.g. `width = 2000` /
+  `height = 1200`.
 - **`deccolm`** — how the 80/132-column DECCOLM switch is realised:
   `"font"` (rescale the glyph cell, the default) or `"window"` (ask the WM
   to resize).

data/example-config.toml

@@ -46,6 +46,14 @@ fontsize = 32
 
 shell="/home/vidarh/bin/rsh"
 
+# Initial window size in pixels. The terminal grid (columns x rows) is
+# derived from this and the font's cell size, so a bigger window opens a
+# bigger terminal. Omit either to use the default (1000 x 600, ~80x24 at
+# the default font). On a large display you might e.g. double them:
+#
+#width  = 2000
+#height = 1200
+
 # DECCOLM (the 80/132-column switch, ESC [ ? 3 h / l) is supported. Choose
 # how the column change is realised:
 #

data/lib/keymap.rb

@@ -87,13 +87,16 @@ KEYMAP = {
   :f3 => "\e[13~",
   :f4 => "\e[14~",
   :f5 => "\e[15~",
-  :f6 => "\e[16~",
-  :f7 => "\e[17~",
-  :f8 => "\e[18~",
-  :f9 => "\e[19~",
-  :f10 => "\e[20~",
-  :f11 => "\e[21~",
-  :f12 => "\e[22~",
+  # VT220/xterm/rxvt skip codes 16, 22, 27, 30, ... so F6+ are not
+  # consecutive with F5. These must match the kf6..kf12 terminfo entries
+  # for TERM (rxvt-256color), or apps like htop won't recognise the keys.
+  :f6 => "\e[17~",
+  :f7 => "\e[18~",
+  :f8 => "\e[19~",
+  :f9 => "\e[20~",
+  :f10 => "\e[21~",
+  :f11 => "\e[23~",
+  :f12 => "\e[24~",
   :shift_up => "\e[1;2A",
   :shift_down => "\e[1;2B",
   :shift_tab => "\e[Z",

data/lib/rubyterm/app.rb

@@ -47,7 +47,8 @@ class RubyTerm
     # :window asks the WM to resize the window. Default :font.
     @deccolm_mode = (@config[:deccolm] || "font").to_s.to_sym
 
-    @window = Window.new(fonts: @config[:fonts], fontsize: @config[:fontsize])
+    @window = Window.new(fonts: @config[:fonts], fontsize: @config[:fontsize],
+                         width: @config[:width], height: @config[:height])
     @adapter = WindowAdapter.new(@window, self)
 
     # Yes, this is "bad" and we should define our

data/lib/rubyterm/engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# rubyterm engine — the reusable terminal core WITHOUT the X11 front end.
+#
+# Loads the escape interpreter (Term), the screen buffer (TermBuffer), the
+# damage tracker (TrackChanges), the escape/UTF-8 parsers, and the ANSI
+# backend (AnsiBackend). None of these depend on X11 or skrift, so a TUI
+# application (e.g. an editor) can drive the buffer and emit minimal escape
+# sequences without being an X client.
+#
+# `require "rubyterm"` loads this and then adds the X11 front end on top.
+
+require "set"
+
+require_relative "version"
+require_relative "../palette"      # PALETTE_BASIC, PALETTE256, FG, BG
+require_relative "../charsets"
+require_relative "../escapeparser"
+require_relative "../utf8decoder"
+require_relative "../termbuffer"
+require_relative "../trackchanges"
+require_relative "../term"
+require_relative "../ansibackend"

data/lib/rubyterm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RubyTerm
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rubyterm.rb

@@ -5,41 +5,27 @@
 # Requiring "rubyterm" loads the whole stack:
 #
 #   * the terminal *engine* - escape interpreter, virtual buffer, damage
-#     tracking and the swappable backends (Term, TrackChanges, TermBuffer,
-#     AnsiBackend, BitmapWindow); usable headlessly / embedded in a TUI; and
-#   * the X11 *front end* - the Window backend, pty Controller, keymap and
-#     the RubyTerm application class that bin/rubyterm runs.
+#     tracking and the ANSI backend (Term, TrackChanges, TermBuffer,
+#     AnsiBackend); usable headlessly / embedded in a TUI. This is
+#     "rubyterm/engine" and carries NO X11/skrift dependency; and
+#   * the X11 *front end* - the Window/BitmapWindow backends, pty Controller,
+#     keymap and the RubyTerm application class that bin/rubyterm runs.
 #
-# The engine carries no X11 dependency itself, but this entry point pulls in
-# the X11/skrift libraries so a single `require "rubyterm"` gives you a
-# runnable terminal. (They are pure Ruby, so requiring them needs no running
-# X server - only instantiating Window does.)
+# A TUI application that only needs the core can `require "rubyterm/engine"`
+# instead and avoid pulling in X11/skrift.
 
+require_relative "rubyterm/engine"
+
+# X11 front end and its dependencies (pure Ruby, so requiring them needs no
+# running X server - only instantiating Window does).
 require "pty"
 require "io/console"
-require "set"
-
 require "X11"
 require "skrift"
 require "skrift/x11"
 require "toml-rb"
 
-require_relative "rubyterm/version"
-
-# Engine
-require_relative "palette"
-require_relative "charsets"
-require_relative "escapeparser"
-require_relative "utf8decoder"
-require_relative "termbuffer"
-require_relative "trackchanges"
-require_relative "term"
-
-# Backends
-require_relative "ansibackend"
-require_relative "bitmapwindow"
-
-# X11 front end
+require_relative "bitmapwindow"    # skrift glyph -> bitmap backend
 require_relative "keymap"
 require_relative "window"
 require_relative "windowadapter"

data/lib/window.rb

@@ -114,7 +114,12 @@ class Window
 
     @visual = @dpy.find_visual(0, 32).visual_id
 
-    @width, @height = 1000, 600
+    # Initial window size in pixels. The terminal grid (cols x rows) is
+    # derived from this by the configure/resize path, so a larger window
+    # opens a larger terminal. Configurable via the `width`/`height` config
+    # keys; defaults sized to roughly 80x24 at the default font.
+    @width  = (opts[:width]  || 1000).to_i
+    @height = (opts[:height] ||  600).to_i
 
     @wid = @dpy.create_window(
       0, 0, @width, @height,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyterm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vidar Hokstad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-06-15 00:00:00.000000000 Z
+date: 2026-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pure-x11
@@ -93,6 +93,7 @@ files:
 - lib/palette.rb
 - lib/rubyterm.rb
 - lib/rubyterm/app.rb
+- lib/rubyterm/engine.rb
 - lib/rubyterm/version.rb
 - lib/term.rb
 - lib/termbuffer.rb