From d6248a32dd724e1cd9c7f9b68c9360f3ad630d47 Mon Sep 17 00:00:00 2001 From: Leah Amelia Chen Date: Sun, 9 Aug 2026 20:19:53 +0800 Subject: [PATCH] ghostty.h: mark as internal Its moniker has been `libghostty-internal` for *quite* a while now among maintainers but that has never really been clarified for the public aside from a couple comments on discussions. Judging by how many people still try to vibe their way into making this work for their purposes, I think we should clear this up once and for all. --- include/ghostty.h | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/include/ghostty.h b/include/ghostty.h index ac7df2b37..a92fa10c5 100644 --- a/include/ghostty.h +++ b/include/ghostty.h @@ -1,10 +1,14 @@ -// Ghostty embedding API. The documentation for the embedding API is -// only within the Zig source files that define the implementations. This -// isn't meant to be a general purpose embedding API (yet) so there hasn't -// been documentation or example work beyond that. +// Ghostty's internal embedder API, a.k.a. "libghostty-internal". // -// The only consumer of this API is the macOS app, but the API is built to -// be more general purpose. +// The only consumer of this API is the macOS app, and while it is fairly +// comprehensive, it is tailored to the needs of the macOS app and not designed +// for external use, hence why most functions are undocumented and some are +// macOS-specific (e.g. ones dealing with the Metal graphics API). +// +// External embedders should instead use `libghostty-vt` or other related +// packages, which are extensively documented and designed from the ground up +// to be used in other software. Header files for which can be found in +// `include/ghostty/`. #ifndef GHOSTTY_H #define GHOSTTY_H