Communitygithub.com

Khatt

Erstellt animierte arabische Kalligraphie (selbstspielendes SVG oder HTML-Seite) aus arabischen, persischen oder Urdu-Texten und erfindet neue Animationseffekte dafür. Verwenden Sie dies, wenn jemand arabische Kalligraphie, ein animiertes arabisches Wort, einen Namen oder Gruß (Ramadan, Eid, Hochzeiten, Geburtstage), ein Kalligraphie-Logo, einen Sticker oder ein Banner wünscht oder bittet, etwas „in arabischer Kalligraphie“ zu schreiben.

Was ist Khatt?

Khatt ist ein leistungsstarkes Kommandozeilen-Tool, das arabische, persische und Urdu-Texte nahtlos in wunderschöne, animierte Kalligraphie verwandelt. Es nutzt HarfBuzz für die korrekte Buchstabenverbindung und -ausrichtung von rechts nach links und erzeugt eine einzige SVG-Datei mit reinem CSS – ganz ohne externe Netzwerke oder Installationen. Das Tool bietet eine breite Palette an Stilen (z. B. Ruqaa, Naskh, Kufi), Layouts (Linie, Bogen, Kreis, Spiegel) und Effekten (Tinte, Gold, Neon, Sand, Laterne u. v. m.), die über benutzerfreundliche Befehlszeilenoptionen gesteuert werden. Es unterstützt außerdem die Erstellung statischer Logos und animierter SVG-Dateien, die in jedem Browser abgespielt werden können. Besonders hervorzuheben ist das erweiterbare Effektsystem: Entwickler können in reinem JavaScript neue Animationseffekte schreiben, ohne zusätzliche Abhängigkeiten, was Khatt ideal für individuelle Kalligraphie-Projekte wie Grußkarten, soziale Medien, Logos oder formelle Einladungen macht.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/M-Alkassem/khatt/tree/HEAD/skills/khatt

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Khatt: animierte arabische Kalligraphie

Khatt formt den Text mit HarfBuzz (Buchstaben verbunden, von rechts nach links, Markierungen an Ort und Stelle), legt ihn aus und animiert ihn mit reinem CSS in einer einzigen SVG-Datei. Kein Netzwerk, keine Installation: Das Skript, seine Schriftarten und die Schriftengine befinden sich alle in diesem Ordner.

Erstellen einer Zeichnung

node scripts/khatt.mjs "النص" --style ruqaa --layout line --effect ink -o out.svg

Führen Sie es aus dem Ordner dieses Skills aus, oder verwenden Sie den vollständigen Pfad zu scripts/khatt.mjs. Schreiben Sie die Ausgabe dorthin, wo der Benutzer sie haben möchte (sein Projektordner, Desktop, …).

OptionWerte
--styleruqaa (alltäglich, schräg), naskh (klassische Buchhand), kufi (eckig), nastaliq (hängendes Persisch), kano (dickes Rohr), blaka (fett, geometrisch)
--layoutline (Linie), arc (Bogen), circle (Ring mit Stern in der Mitte), mirror (klassisch gespiegelt musanna)
--effectink (Tinte), gold (Gold), bleed (Verlauf), mosaic (Mosaik), sand (Sand), neon (Neon), stars (Sterne), lantern (Laterne), rise (Aufstieg), stamp (Stempel), reveal (Enthüllung), wave (Welle) oder ein Pfad zu einer .mjs-Effektdatei
--palettepaper (Papier), night (Nacht), neon (Neon), zellige (Zellige), desert (Wüste), clear (transparent)
--ink, --accent, --bgFarben überschreiben, z. B. --ink "#0b3d2e" --bg none
--stillEinfrieren auf der fertigen Zeichnung (gut für Logos und Druck)
-o.svg für die Datei selbst, .html für eine Seite, die bei Klick erneut abspielt

Führen Sie node scripts/khatt.mjs --list aus, um alles mit kurzen Beschreibungen zu sehen. Verwenden Sie \n im Text für eine zweite Zeile (bis zu vier Zeilen).

Gut auswählen

  • Namen und englische Wörter: Khatt zeichnet nur arabische Schrift. Transkribieren Sie zuerst (Sara → سارة, Kamangir → كمنجير) und zeigen Sie dem Benutzer, wenn die Schreibweise mehrere Möglichkeiten hat, Ihre Schreibweise vor dem Rendern.
  • Ramadan oder Eid: lantern oder gold mit night, Stil naskh oder ruqaa.
  • Hochzeiten und formelle Karten: gold, rise oder ink; versuchen Sie --layout mirror.
  • Logos: --still, Stil kufi oder blaka, --palette clear.
  • Social-Media-Beiträge: Eine animierte .svg Datei wird überall dort abgespielt, wo ein Browser läuft. Für ein Video verweisen Sie den Benutzer auf das Studio (https://m-alkassem.github.io/khatt/), das MP4 exportiert.
  • Kurze Texte sehen am besten aus. Lange Sätze: line-Layout, zwei oder drei Zeilen.

Öffnen Sie das Ergebnis für den Benutzer, wenn möglich (z. B. open out.html unter macOS).

Einen neuen Effekt erstellen

Wenn keiner der zwölf Effekte passt („Lass die Buchstaben brennen“, „Eine Ramadan-Laterne, die schaukelt“), schreiben Sie einen neuen. Beginnen Sie mit examples/ripple.mjs. Ein Effekt ist ein einfaches Objekt ohne Importe:

export default {
  id: "my-effect", name: "My effect", nameAr: "…", blurb: "…",
  palette: "night",          // Standard-Paletten-ID
  loop: false,               // true, wenn es sich weiterbewegt
  render(ctx) {
    // return { css, defs?, body, duration, poster? }
  },
};

render(ctx) erhält:

  • ctx.pieces: ein Eintrag pro Glyphe: d (SVG-Pfad), order (Lesereihenfolge, 0 = erster Buchstabe), box {x0,y0,x1,y1}, cx, cy. Gespiegelte Kopien teilen sich eine Reihenfolge.
  • ctx.steps, ctx.box (Textbox), ctx.view (gesamte Leinwand), ctx.em (Schriftgröße, 100), ctx.palette (bg, ink, accent), ctx.rng() (seeded random).
  • ctx.stagger(order, spread?): Verzögerung für einen Buchstaben, verteilt über spread Sekunden.
  • ctx.sample(piece, count): Zufallspunkte innerhalb eines Buchstabens für Partikel.
  • ctx.inside(piece, x, y), ctx.area(piece).
  • ctx.anim(name, seconds, { ease, loop, alternate }): Animations-CSS für eine Klasse.
  • ctx.at(seconds, extraStyle?): der Inline-Stil, der die Verzögerung eines Elements setzt.
  • ctx.n(number): Rundet Zahlen für kompakte Ausgabe.
  • ctx.p: ein eindeutiges Präfix. Verwenden Sie es für jede Klasse, ID und Keyframe-Bezeichnung.

Regeln, die das Zeichnen in jedem Frame pausierbar halten (davon hängen Standbilder und Videoexport ab):

  1. Jedes animierte Element erhält class="${p}-a ..." und style="${at(seconds)}".
  2. Verwenden Sie ctx.anim(...) in Ihren Klassenregeln. Schreiben Sie niemals die Kurzform animation: oder setzen Sie animation-delay selbst.
  3. Benennen Sie Keyframes ${p}-something. Fügen Sie ${p}-b zu einem Element hinzu, um es um seinen eigenen Mittelpunkt zu skalieren oder zu drehen.
  4. Animieren Sie nur CSS-Eigenschaften (opacity, transform, stroke-dashoffset, fill-opacity, …). SMIL <animate> und Skripte werden nicht korrekt einfrieren.
  5. Halten Sie es leicht: höchstens ein paar tausend Elemente.

Dann führen Sie es aus:

node scripts/khatt.mjs "نار" --effect ./my-effect.mjs -o fire.html

Wenn es dem Benutzer gefällt, schlagen Sie vor, es als Pull-Request auf https://github.com/M-Alkassem/khatt zu teilen (Effekte leben in src/effects/).

Verwandte Skills