Add XTERM renderer.

Author: HexDecimal

CHANGELOG.rst

@@ -8,6 +8,9 @@ v2.0.0
 
 Unreleased
 ------------------
+Added
+ - New experimental renderer `tcod.context.RENDERER_XTERM`.
+
 Fixed
  - Functions accepting `Path`-like parameters now accept the more correct `os.PathLike` type.
 

build_libtcod.py

@@ -388,13 +388,15 @@ def parse_sdl_attrs(prefix: str, all_names: List[str]) -> Tuple[str, str]:
     "TCOD_KEY_TEXT_SIZE",
     "TCOD_NOISE_MAX_DIMENSIONS",
     "TCOD_NOISE_MAX_OCTAVES",
+    "TCOD_FALLBACK_FONT_SIZE",
 ]
 
 EXCLUDE_CONSTANT_PREFIXES = [
     "TCOD_E_",
     "TCOD_HEAP_",
     "TCOD_LEX_",
     "TCOD_CHARMAP_",
+    "TCOD_LOG_",
 ]
 
 

tcod/__init__.py

@@ -556,6 +556,7 @@
     "RENDERER_OPENGL2",
     "RENDERER_SDL",
     "RENDERER_SDL2",
+    "RENDERER_XTERM",
     "RIGHT",
     "RNG_CMWC",
     "RNG_MT",

tcod/constants.py

@@ -247,7 +247,7 @@
 KEY_PRESSED = 1
 KEY_RELEASED = 2
 LEFT = 0
-NB_RENDERERS = 5
+NB_RENDERERS = 6
 NOISE_DEFAULT = 0
 NOISE_PERLIN = 1
 NOISE_SIMPLEX = 2
@@ -257,6 +257,7 @@
 RENDERER_OPENGL2 = 4
 RENDERER_SDL = 2
 RENDERER_SDL2 = 3
+RENDERER_XTERM = 5
 RIGHT = 1
 RNG_CMWC = 1
 RNG_MT = 0
@@ -755,6 +756,7 @@
     "RENDERER_OPENGL2",
     "RENDERER_SDL",
     "RENDERER_SDL2",
+    "RENDERER_XTERM",
     "RIGHT",
     "RNG_CMWC",
     "RNG_MT",

tcod/context.py

@@ -80,6 +80,7 @@
     "RENDERER_OPENGL2",
     "RENDERER_SDL",
     "RENDERER_SDL2",
+    "RENDERER_XTERM",
 )
 
 SDL_WINDOW_FULLSCREEN = lib.SDL_WINDOW_FULLSCREEN
@@ -126,6 +127,19 @@
 Rendering is decided by SDL2 and can be changed by using an SDL2 hint:
 https://wiki.libsdl.org/SDL_HINT_RENDER_DRIVER
 """
+RENDERER_XTERM = lib.TCOD_RENDERER_XTERM
+"""A renderer targeting modern terminals with 24-bit color support.
+
+This is an experimental renderer with partial support for XTerm and SSH.
+This will work best on those terminals.
+
+Terminal inputs and events will be passed to SDL's event system.
+
+There is poor support for ANSI escapes on Windows 10.
+It is not recommended to use this renderer on Windows.
+
+.. versionadded:: 13.3
+"""
 
 
 def _handle_tileset(tileset: Optional[tcod.tileset.Tileset]) -> Any:

tcod/libtcodpy.py

@@ -4713,6 +4713,7 @@ def _atexit_verify() -> None:
     "RENDERER_OPENGL2",
     "RENDERER_SDL",
     "RENDERER_SDL2",
+    "RENDERER_XTERM",
     "RIGHT",
     "RNG_CMWC",
     "RNG_MT",