@glyph-engine/desktop 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# @glyph-engine/desktop
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[GlyphEngine](https://github.com/tomast1337/GlyphEngine) in a native window: `run()` draws through SDL3 with Vulkan, OpenGL, SDL GPU or a software renderer. No npm dependencies: SDL is linked with `bun:ffi`. Re-exports `@glyph-engine/core`.
+
+Needs [Bun](https://bun.com), SDL3, SDL3_ttf and fontconfig. Linux only for now; macOS and Windows throw "not supported yet" (contributions welcome).
+
+```
+pacman -S sdl3 sdl3_ttf              # Arch
+bun add @glyph-engine/desktop
+```
+
+```ts
+import { run } from '@glyph-engine/desktop';
+
+await run(
+    {
+        main(coord, context, cursor, out) {
+            out.char = '#';
+            out.color = 'red';
+        },
+    },
+    { renderer: 'vulkan' }, // or opengl, opengles2, gpu, software; omit to let SDL choose
+);
+```
+
+Escape or closing the window quits.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from '@glyph-engine/core';
+export { renderDrivers } from './sdl';
+export { run } from './run';
+export { run as default } from './run';

package/dist/index.js

@@ -0,0 +1,419 @@
+// @bun
+// src/index.ts
+export * from "@glyph-engine/core";
+
+// src/sdl.ts
+import { CString, dlopen, FFIType, read } from "bun:ffi";
+var { ptr, i32, u32, u64, f32, bool, cstring, u64_fast } = FFIType;
+var size_t = u64_fast;
+var REPO = "https://github.com/tomast1337/GlyphEngine";
+function libraries() {
+  switch (process.platform) {
+    case "linux":
+      return { sdl: "libSDL3.so.0", ttf: "libSDL3_ttf.so.0" };
+    case "darwin":
+      throw new Error(`The desktop runner does not support macOS yet. Contributions welcome: ${REPO}`);
+    case "win32":
+      throw new Error(`The desktop runner does not support Windows yet. Contributions welcome: ${REPO}`);
+    default:
+      throw new Error(`The desktop runner does not support ${process.platform}. Open an issue: ${REPO}/issues`);
+  }
+}
+function open() {
+  const names = libraries();
+  try {
+    const sdl = dlopen(names.sdl, {
+      SDL_Init: { args: [u32], returns: bool },
+      SDL_Quit: { returns: FFIType.void },
+      SDL_GetError: { returns: ptr },
+      SDL_SetHint: { args: [cstring, cstring], returns: bool },
+      SDL_CreateWindow: { args: [cstring, i32, i32, u64], returns: ptr },
+      SDL_DestroyWindow: { args: [ptr], returns: FFIType.void },
+      SDL_GetWindowSizeInPixels: { args: [ptr, ptr, ptr], returns: bool },
+      SDL_GetWindowPixelDensity: { args: [ptr], returns: f32 },
+      SDL_GetNumRenderDrivers: { returns: i32 },
+      SDL_GetRenderDriver: { args: [i32], returns: ptr },
+      SDL_CreateRenderer: { args: [ptr, cstring], returns: ptr },
+      SDL_DestroyRenderer: { args: [ptr], returns: FFIType.void },
+      SDL_GetRendererName: { args: [ptr], returns: ptr },
+      SDL_SetRenderDrawColor: { args: [ptr, FFIType.u8, FFIType.u8, FFIType.u8, FFIType.u8], returns: bool },
+      SDL_RenderClear: { args: [ptr], returns: bool },
+      SDL_RenderGeometry: { args: [ptr, ptr, ptr, i32, ptr, i32], returns: bool },
+      SDL_RenderPresent: { args: [ptr], returns: bool },
+      SDL_RenderReadPixels: { args: [ptr, ptr], returns: ptr },
+      SDL_CreateTexture: { args: [ptr, u32, i32, i32, i32], returns: ptr },
+      SDL_DestroyTexture: { args: [ptr], returns: FFIType.void },
+      SDL_UpdateTexture: { args: [ptr, ptr, ptr, i32], returns: bool },
+      SDL_SetTextureBlendMode: { args: [ptr, u32], returns: bool },
+      SDL_SetTextureScaleMode: { args: [ptr, i32], returns: bool },
+      SDL_ConvertSurface: { args: [ptr, u32], returns: ptr },
+      SDL_DestroySurface: { args: [ptr], returns: FFIType.void },
+      SDL_PollEvent: { args: [ptr], returns: bool }
+    });
+    const ttf = dlopen(names.ttf, {
+      TTF_Init: { returns: bool },
+      TTF_OpenFont: { args: [cstring, f32], returns: ptr },
+      TTF_CloseFont: { args: [ptr], returns: FFIType.void },
+      TTF_AddFallbackFont: { args: [ptr, ptr], returns: bool },
+      TTF_SetFontStyle: { args: [ptr, u32], returns: FFIType.void },
+      TTF_GetFontHeight: { args: [ptr], returns: i32 },
+      TTF_GetStringSize: { args: [ptr, ptr, size_t, ptr, ptr], returns: bool },
+      TTF_RenderText_Blended: { args: [ptr, ptr, size_t, u32], returns: ptr }
+    });
+    return { ...sdl.symbols, ...ttf.symbols };
+  } catch (e) {
+    throw new Error(`The desktop runner needs SDL3 and SDL3_ttf (${names.sdl}, ${names.ttf}): ${e.message}`);
+  }
+}
+var lib;
+function sdl() {
+  return lib ??= open();
+}
+function sdlError(what) {
+  const p = sdl().SDL_GetError();
+  return new Error(`${what}: ${p ? new CString(p) : "unknown SDL error"}`);
+}
+function renderDrivers() {
+  const s = sdl();
+  return Array.from({ length: s.SDL_GetNumRenderDrivers() }, (_, i) => String(new CString(s.SDL_GetRenderDriver(i))));
+}
+function surfaceInfo(surface) {
+  return { format: read.u32(surface, 4), w: read.i32(surface, 8), h: read.i32(surface, 12), pitch: read.i32(surface, 16), pixels: read.ptr(surface, 24) };
+}
+var SDL_INIT_VIDEO = 32;
+var SDL_WINDOW_RESIZABLE = 0x20n;
+var SDL_WINDOW_HIGH_PIXEL_DENSITY = 0x2000n;
+var SDL_PIXELFORMAT_ARGB8888 = 372645892;
+var SDL_TEXTUREACCESS_STATIC = 0;
+var SDL_BLENDMODE_BLEND = 1;
+var SDL_SCALEMODE_NEAREST = 0;
+var SDL_EVENT_QUIT = 256;
+var SDL_EVENT_WINDOW_EXPOSED = 516;
+var SDL_EVENT_WINDOW_RESIZED = 518;
+var SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED = 519;
+var SDL_EVENT_KEY_DOWN = 768;
+var SDL_EVENT_MOUSE_MOTION = 1024;
+var SDL_EVENT_MOUSE_BUTTON_DOWN = 1025;
+var SDL_EVENT_MOUSE_BUTTON_UP = 1026;
+var SDLK_ESCAPE = 27;
+var TTF_STYLE_NORMAL = 0;
+var TTF_STYLE_BOLD = 1;
+// src/run.ts
+import { CString as CString2, ptr as addressOf2 } from "bun:ffi";
+import { startLoop } from "@glyph-engine/core";
+
+// src/renderer.ts
+import { ptr as addressOf, toArrayBuffer } from "bun:ffi";
+import { cssColor, getChar, weightCode } from "@glyph-engine/core";
+var ATLAS = 2048;
+var FLOATS = 8;
+
+class Renderer {
+  renderer;
+  font;
+  cellW;
+  cellH;
+  #glyphs = new Map;
+  #next = 1;
+  #perRow;
+  #capacity;
+  #slotW;
+  #texture;
+  #vertices = new Float32Array(0);
+  #indices = new Int32Array(0);
+  #rect = new Int32Array(4);
+  #encoder = new TextEncoder;
+  constructor(renderer, font, cellW, cellH) {
+    this.renderer = renderer;
+    this.font = font;
+    this.cellW = cellW;
+    this.cellH = cellH;
+    const s = sdl();
+    this.#slotW = Math.ceil(cellW * 2);
+    this.#perRow = Math.floor(ATLAS / this.#slotW);
+    this.#capacity = this.#perRow * Math.floor(ATLAS / cellH);
+    const texture = s.SDL_CreateTexture(renderer, SDL_PIXELFORMAT_ARGB8888, SDL_TEXTUREACCESS_STATIC, ATLAS, ATLAS);
+    if (!texture)
+      throw sdlError("SDL_CreateTexture");
+    this.#texture = texture;
+    s.SDL_SetTextureBlendMode(texture, SDL_BLENDMODE_BLEND);
+    s.SDL_SetTextureScaleMode(texture, SDL_SCALEMODE_NEAREST);
+    const white = new Uint32Array(4 * 4).fill(4294967295);
+    this.#upload(0, 0, 4, 4, addressOf(white), 16);
+  }
+  draw(frame, settings) {
+    const s = sdl();
+    const { cols, rows, fg, bg, weight } = frame;
+    const dFg = settings.color && cssColor(settings.color) || 255;
+    const dBg = settings.backgroundColor && cssColor(settings.backgroundColor) || 4294967295;
+    const dWeight = weightCode(settings.fontWeight);
+    const quads = cols * rows * 2;
+    if (this.#vertices.length < quads * 4 * FLOATS)
+      this.#grow(quads);
+    const v = this.#vertices;
+    const { cellW, cellH } = this;
+    const white = 2 / ATLAS;
+    let n = 0;
+    const quad = (x0, y0, x1, y1, c, u0, v0, u1, v1) => {
+      const r = (c >>> 24) / 255;
+      const g = (c >>> 16 & 255) / 255;
+      const b = (c >>> 8 & 255) / 255;
+      const a = (c & 255) / 255;
+      for (let i = 0;i < 4; i++) {
+        const right = i & 1;
+        const bottom = i >> 1;
+        v[n++] = right ? x1 : x0;
+        v[n++] = bottom ? y1 : y0;
+        v[n++] = r;
+        v[n++] = g;
+        v[n++] = b;
+        v[n++] = a;
+        v[n++] = right ? u1 : u0;
+        v[n++] = bottom ? v1 : v0;
+      }
+    };
+    for (let y = 0;y < rows; y++) {
+      let col = 0;
+      for (let i = 0, k = y * cols;i < cols && col < cols; i++, k++) {
+        const char = getChar(frame, k);
+        const glyph = char && char !== " " ? this.#glyph(char, weight[k] || dWeight) : undefined;
+        const span = glyph?.wide && col + 1 < cols ? 2 : 1;
+        const x0 = col * cellW;
+        const y0 = y * cellH;
+        quad(x0, y0, x0 + span * cellW, y0 + cellH, bg[k] || dBg, white, white, white, white);
+        if (glyph) {
+          const gx = glyph.slot % this.#perRow * this.#slotW;
+          const gy = Math.floor(glyph.slot / this.#perRow) * cellH;
+          const w = this.#slotW;
+          quad(x0, y0, x0 + w, y0 + cellH, glyph.colored ? 4294967295 : fg[k] || dFg, gx / ATLAS, gy / ATLAS, (gx + w) / ATLAS, (gy + cellH) / ATLAS);
+        }
+        col += span;
+      }
+    }
+    const r = dBg >>> 24;
+    s.SDL_SetRenderDrawColor(this.renderer, r, dBg >>> 16 & 255, dBg >>> 8 & 255, 255);
+    s.SDL_RenderClear(this.renderer);
+    const count = n / FLOATS;
+    if (count && !s.SDL_RenderGeometry(this.renderer, this.#texture, addressOf(v), count, addressOf(this.#indices), count / 4 * 6))
+      throw sdlError("SDL_RenderGeometry");
+  }
+  present() {
+    sdl().SDL_RenderPresent(this.renderer);
+  }
+  destroy() {
+    sdl().SDL_DestroyTexture(this.#texture);
+  }
+  #grow(quads) {
+    this.#vertices = new Float32Array(quads * 4 * FLOATS);
+    this.#indices = new Int32Array(quads * 6);
+    for (let q = 0;q < quads; q++)
+      this.#indices.set([0, 1, 2, 2, 1, 3].map((i) => i + q * 4), q * 6);
+  }
+  #glyph(char, weight) {
+    const key = weight + char;
+    let glyph = this.#glyphs.get(key);
+    if (glyph)
+      return glyph;
+    if (this.#next >= this.#capacity) {
+      this.#glyphs.clear();
+      this.#next = 1;
+    }
+    const s = sdl();
+    const slot = this.#next++;
+    const text = this.#encoder.encode(char);
+    if (weight >= 6)
+      s.TTF_SetFontStyle(this.font, TTF_STYLE_BOLD);
+    let surface = s.TTF_RenderText_Blended(this.font, addressOf(text), text.length, 4294967295);
+    if (weight >= 6)
+      s.TTF_SetFontStyle(this.font, TTF_STYLE_NORMAL);
+    glyph = { slot, wide: false, colored: false };
+    if (surface) {
+      if (surfaceInfo(surface).format !== SDL_PIXELFORMAT_ARGB8888) {
+        const converted = s.SDL_ConvertSurface(surface, SDL_PIXELFORMAT_ARGB8888);
+        s.SDL_DestroySurface(surface);
+        surface = converted;
+      }
+    }
+    if (surface) {
+      const { w, h, pitch, pixels } = surfaceInfo(surface);
+      glyph.wide = w > this.cellW * 1.5;
+      glyph.colored = isColored(new Uint8Array(toArrayBuffer(pixels, 0, pitch * h)), w, h, pitch);
+      this.#upload(slot % this.#perRow * this.#slotW, Math.floor(slot / this.#perRow) * this.cellH, Math.min(w, this.#slotW), Math.min(h, this.cellH), pixels, pitch);
+      s.SDL_DestroySurface(surface);
+    }
+    this.#glyphs.set(key, glyph);
+    return glyph;
+  }
+  #upload(x, y, w, h, pixels, pitch) {
+    this.#rect.set([x, y, w, h]);
+    if (!sdl().SDL_UpdateTexture(this.#texture, addressOf(this.#rect), pixels, pitch))
+      throw sdlError("SDL_UpdateTexture");
+  }
+}
+function isColored(px, w, h, pitch) {
+  for (let y = 0;y < h; y++) {
+    for (let x = 0, o = y * pitch;x < w; x++, o += 4) {
+      if (px[o + 3] > 0 && (px[o] !== px[o + 1] || px[o + 1] !== px[o + 2]))
+        return true;
+    }
+  }
+  return false;
+}
+
+// src/run.ts
+var defaultSettings = {
+  element: null,
+  cols: 0,
+  rows: 0,
+  once: false,
+  fps: 30,
+  renderer: "",
+  allowSelect: false,
+  restoreState: false,
+  fontFamily: "monospace",
+  fontSize: "16px"
+};
+function fontFile(family) {
+  const first = family.split(",")[0].trim().replace(/^["']|["']$/g, "") || "monospace";
+  const found = Bun.spawnSync(["fc-match", "-f", "%{file}", first]);
+  if (!found.success || !found.stdout.length)
+    throw new Error(`No font file for "${first}" (fontconfig's fc-match is needed)`);
+  return found.stdout.toString();
+}
+function emojiFile() {
+  const found = Bun.spawnSync(["fc-match", "-f", "%{file}", "emoji"]);
+  return found.success && found.stdout.length ? found.stdout.toString() : undefined;
+}
+function driverFor(runSettings, settings) {
+  const drivers = renderDrivers();
+  for (const name of [runSettings.renderer, settings.renderer])
+    if (name && drivers.includes(name))
+      return name;
+  return null;
+}
+function run(program, runSettings = {}, userData = {}) {
+  return new Promise((resolve, reject) => {
+    const settings = { ...defaultSettings, ...runSettings, ...program.settings };
+    const s = sdl();
+    const ints = new Int32Array(2);
+    const event = new Uint8Array(128);
+    const view = new DataView(event.buffer);
+    let window = null;
+    let gpu = null;
+    let renderer;
+    let font = null;
+    let started = false;
+    let last;
+    let polling;
+    const close = () => {
+      clearInterval(polling);
+      renderer?.destroy();
+      renderer = undefined;
+      if (gpu)
+        s.SDL_DestroyRenderer(gpu);
+      if (window)
+        s.SDL_DestroyWindow(window);
+      gpu = window = null;
+      s.SDL_Quit();
+    };
+    const fail = (e) => {
+      close();
+      if (!started)
+        reject(e);
+      else
+        throw e;
+    };
+    try {
+      if (!s.SDL_Init(SDL_INIT_VIDEO))
+        throw sdlError("SDL_Init");
+      if (!s.TTF_Init())
+        throw sdlError("TTF_Init");
+      window = s.SDL_CreateWindow(Buffer.from("GlyphEngine\x00"), 960, 600, SDL_WINDOW_RESIZABLE | SDL_WINDOW_HIGH_PIXEL_DENSITY);
+      if (!window)
+        throw sdlError("SDL_CreateWindow");
+      const driver = driverFor(runSettings, settings);
+      gpu = s.SDL_CreateRenderer(window, driver ? Buffer.from(driver + "\x00") : null);
+      if (!gpu)
+        throw sdlError(`SDL_CreateRenderer (${driver ?? "default"})`);
+      settings.renderer = String(new CString2(s.SDL_GetRendererName(gpu)));
+      const density = s.SDL_GetWindowPixelDensity(window) || 1;
+      font = s.TTF_OpenFont(Buffer.from(fontFile(settings.fontFamily ?? "monospace") + "\x00"), (parseFloat(settings.fontSize ?? "16") || 16) * density);
+      if (!font)
+        throw sdlError("TTF_OpenFont");
+      const emoji = emojiFile();
+      const emojiFont = emoji && s.TTF_OpenFont(Buffer.from(emoji + "\x00"), (parseFloat(settings.fontSize ?? "16") || 16) * density);
+      if (emojiFont)
+        s.TTF_AddFallbackFont(font, emojiFont);
+      const x = Buffer.from("X");
+      s.TTF_GetStringSize(font, addressOf2(x), 1, addressOf2(ints), addressOf2(ints, 4));
+      const cellW = ints[0];
+      const cellH = s.TTF_GetFontHeight(font);
+      renderer = new Renderer(gpu, font, cellW, cellH);
+      const state = { time: 0, frame: 0, cycle: 0, fps: settings.fps };
+      const pointer = { x: 0, y: 0, pressed: false, px: 0, py: 0, ppressed: false };
+      const events = [];
+      const poll = () => {
+        while (s.SDL_PollEvent(addressOf2(event))) {
+          const type = view.getUint32(0, true);
+          if (type === SDL_EVENT_QUIT || type === SDL_EVENT_KEY_DOWN && view.getUint32(28, true) === SDLK_ESCAPE) {
+            close();
+            process.exit(0);
+          } else if (type === SDL_EVENT_WINDOW_EXPOSED || type === SDL_EVENT_WINDOW_RESIZED || type === SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED) {
+            if (last) {
+              renderer.draw(last, settings);
+              renderer.present();
+            }
+          } else if (type === SDL_EVENT_MOUSE_MOTION || type === SDL_EVENT_MOUSE_BUTTON_DOWN || type === SDL_EVENT_MOUSE_BUTTON_UP) {
+            pointer.x = view.getFloat32(28, true) * density;
+            pointer.y = view.getFloat32(32, true) * density;
+            if (type === SDL_EVENT_MOUSE_MOTION) {
+              events.push("pointerMove");
+            } else {
+              pointer.pressed = type === SDL_EVENT_MOUSE_BUTTON_DOWN;
+              events.push(pointer.pressed ? "pointerDown" : "pointerUp");
+            }
+          }
+        }
+      };
+      const host = {
+        requestFrame: (cb) => setTimeout(() => {
+          try {
+            cb(performance.now());
+          } catch (e) {
+            fail(e);
+          }
+        }, 4),
+        metrics: { aspect: cellW / cellH, cellWidth: cellW, lineHeight: cellH, fontFamily: settings.fontFamily ?? "monospace", fontSize: cellH, _update: () => {} },
+        size: () => {
+          s.SDL_GetWindowSizeInPixels(window, addressOf2(ints), addressOf2(ints, 4));
+          return { width: ints[0], height: ints[1] };
+        },
+        pointer,
+        events,
+        render: (_context, frame) => {
+          last = frame;
+          renderer.draw(frame, settings);
+          renderer.present();
+        }
+      };
+      polling = setInterval(() => {
+        try {
+          poll();
+        } catch (e) {
+          fail(e);
+        }
+      }, 4);
+      startLoop(program, settings, userData, state, host, (context) => {
+        started = true;
+        resolve(context);
+      });
+    } catch (e) {
+      fail(e);
+    }
+  });
+}
+export {
+  run as default,
+  renderDrivers,
+  run
+};

package/dist/renderer.d.ts

@@ -0,0 +1,18 @@
+/**
+@module   renderer
+@desc     draws frames into an SDL window: glyph atlas texture + one SDL_RenderGeometry per frame
+@category desktop
+*/
+import { type Pointer } from 'bun:ffi';
+import { type Frame, type Settings } from '@glyph-engine/core';
+export declare class Renderer {
+    #private;
+    readonly renderer: Pointer;
+    readonly font: Pointer;
+    readonly cellW: number;
+    readonly cellH: number;
+    constructor(renderer: Pointer, font: Pointer, cellW: number, cellH: number);
+    draw(frame: Frame, settings: Partial<Settings>): void;
+    present(): void;
+    destroy(): void;
+}

package/dist/run.d.ts

@@ -0,0 +1,7 @@
+/**
+Runs a program in a native window through SDL3 (bun:ffi, no npm dependencies).
+settings.renderer picks SDL's backend: "vulkan", "opengl", "opengles2", "gpu" or
+"software"; anything else lets SDL choose. Closing the window or Escape quits.
+*/
+import { type Context, type Program, type Settings } from '@glyph-engine/core';
+export declare function run(program: Program, runSettings?: Partial<Settings>, userData?: object): Promise<Context>;

package/dist/sdl.d.ts

@@ -0,0 +1,172 @@
+/**
+@module   sdl
+@desc     the parts of SDL3 and SDL3_ttf the desktop runner uses, through bun:ffi
+@category desktop
+*/
+import { CString, type Pointer } from 'bun:ffi';
+export declare function sdl(): {
+    TTF_Init: {
+        (): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    TTF_OpenFont: {
+        (...args: (number | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    TTF_CloseFont: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): undefined;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    TTF_AddFallbackFont: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    TTF_SetFontStyle: {
+        (...args: (number | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): undefined;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    TTF_GetFontHeight: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): number;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    TTF_GetStringSize: {
+        (...args: (number | bigint | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    TTF_RenderText_Blended: {
+        (...args: (number | bigint | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_Init: {
+        (...args: number[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_Quit: {
+        (): undefined;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_GetError: {
+        (): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_SetHint: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_CreateWindow: {
+        (...args: (number | bigint | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_DestroyWindow: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): undefined;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_GetWindowSizeInPixels: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_GetWindowPixelDensity: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): number;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_GetNumRenderDrivers: {
+        (): number;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_GetRenderDriver: {
+        (...args: number[]): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_CreateRenderer: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_DestroyRenderer: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): undefined;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_GetRendererName: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_SetRenderDrawColor: {
+        (...args: (number | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_RenderClear: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_RenderGeometry: {
+        (...args: (number | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_RenderPresent: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_RenderReadPixels: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_CreateTexture: {
+        (...args: (number | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_DestroyTexture: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): undefined;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_UpdateTexture: {
+        (...args: (number | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_SetTextureBlendMode: {
+        (...args: (number | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_SetTextureScaleMode: {
+        (...args: (number | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_ConvertSurface: {
+        (...args: (number | Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): Pointer | null;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_DestroySurface: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): undefined;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+    SDL_PollEvent: {
+        (...args: (Pointer | CString | NodeJS.TypedArray<ArrayBufferLike> | null)[]): boolean;
+        __ffi_function_callable: typeof import("bun:ffi").FFIFunctionCallableSymbol;
+    };
+};
+export declare function sdlError(what: string): Error;
+export declare function renderDrivers(): string[];
+export declare function surfaceInfo(surface: Pointer): {
+    format: number;
+    w: number;
+    h: number;
+    pitch: number;
+    pixels: Pointer;
+};
+export declare const SDL_INIT_VIDEO = 32;
+export declare const SDL_WINDOW_RESIZABLE = 32n;
+export declare const SDL_WINDOW_HIGH_PIXEL_DENSITY = 8192n;
+export declare const SDL_WINDOW_HIDDEN = 8n;
+export declare const SDL_PIXELFORMAT_ARGB8888 = 372645892;
+export declare const SDL_TEXTUREACCESS_STATIC = 0;
+export declare const SDL_BLENDMODE_BLEND = 1;
+export declare const SDL_SCALEMODE_NEAREST = 0;
+export declare const SDL_EVENT_QUIT = 256;
+export declare const SDL_EVENT_WINDOW_EXPOSED = 516;
+export declare const SDL_EVENT_WINDOW_RESIZED = 518;
+export declare const SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED = 519;
+export declare const SDL_EVENT_KEY_DOWN = 768;
+export declare const SDL_EVENT_MOUSE_MOTION = 1024;
+export declare const SDL_EVENT_MOUSE_BUTTON_DOWN = 1025;
+export declare const SDL_EVENT_MOUSE_BUTTON_UP = 1026;
+export declare const SDLK_ESCAPE = 27;
+export declare const TTF_STYLE_NORMAL = 0;
+export declare const TTF_STYLE_BOLD = 1;

package/package.json

@@ -1,6 +1,46 @@
 {
-  "name": "@glyph-engine/desktop",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+    "name": "@glyph-engine/desktop",
+    "version": "0.1.1",
+    "description": "GlyphEngine in a native window: run() draws through SDL3 (OpenGL, Vulkan, SDL GPU or software) via bun:ffi. Linux for now; needs SDL3 and SDL3_ttf.",
+    "keywords": [
+        "ascii",
+        "ascii-art",
+        "sdl3",
+        "vulkan",
+        "opengl",
+        "bun",
+        "ffi"
+    ],
+    "license": "Apache-2.0",
+    "homepage": "https://github.com/tomast1337/GlyphEngine#readme",
+    "bugs": "https://github.com/tomast1337/GlyphEngine/issues",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/tomast1337/GlyphEngine.git",
+        "directory": "packages/desktop"
+    },
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "engines": {
+        "bun": ">=1.4.4"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "build": "rm -rf dist && bun build src/index.ts --target bun --outdir dist --external @glyph-engine/core && tsc -p tsconfig.build.json",
+        "prepublishOnly": "bun run build",
+        "prepack": "cp ../../LICENSE ."
+    },
+    "dependencies": {
+        "@glyph-engine/core": "0.1.1"
+    }
+}