Communitygithub.com

khatt

アラビア語、ペルシア語、ウルドゥー語のテキストからアニメーション化されたアラビア書道(セルフプレイSVGまたはHTMLページ)を作成し、新しいアニメーション効果を発明します。

khatt とは?

Khattは、アラビア語、ペルシア語、ウルドゥー語のテキストから、アニメーション化されたアラビア書道のSVGまたはHTMLファイルを生成するツールです。HarfBuzzを使用して文字を正しく結合・配置し、純粋なCSSアニメーションを一つのSVGファイル内で実現します。インストールやネットワーク接続は不要で、スクリプト、フォント、整形エンジンがすべてこのフォルダ内に含まれています。主な機能として、複数の書体(ruqaa、naskh、kufi、nastaliqなど)、レイアウト(line、arc、circle、mirror)、12種類以上のアニメーション効果(ink、gold、bleed、mosaic、sand、neon、stars、lanternなど)を備えています。カスタムエフェクトの作成も可能で、エフェクトはプレーンなJavaScriptオブジェクトとして定義し、アニメーションの一時停止やビデオ出力にも対応しています。RamadanやEidの挨拶、結婚式カード、ロゴ、SNS投稿など様々な用途に適しています。

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

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

Khatt: アニメーションアラビア書道

Khatt は HarfBuzz を使用してテキストを整形し(文字の結合、右から左、マークの配置)、レイアウトし、純粋な CSS アニメーションで一つの SVG ファイル内でアニメーション化します。ネットワーク不要、インストール不要:スクリプト、フォント、整形エンジンはすべてこのフォルダ内にあります。

描画を作成する

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

このスキルのフォルダから実行するか、scripts/khatt.mjs へのフルパスを使用します。出力はユーザーが希望する場所(プロジェクトフォルダ、デスクトップなど)に書き込みます。

オプション値
--styleruqaa(日常的、斜体)、naskh(古典的な書籍体)、kufi(角ばった書体)、nastaliq(ペルシア語の垂れ下がる書体)、kano(太い葦ペン)、blaka(太い幾何学書体)
--layoutline、arc、circle(中央に星があるリング)、mirror(古典的な鏡像 musanna)
--effectink、gold、bleed、mosaic、sand、neon、stars、lantern、rise、stamp、reveal、wave、または .mjs エフェクトへのパス
--palettepaper、night、neon、zellige、desert、clear(透明)
--ink、--accent、--bg色の上書き、例:--ink "#0b3d2e" --bg none
--still完成した描画で静止(ロゴや印刷物に適しています)
-o.svg はファイル自体、.html はクリックで再生されるページ

node scripts/khatt.mjs --list を実行すると、すべてのオプションと簡単な説明が表示されます。 テキスト内で \n を使用すると2行目(最大4行)になります。

選択のコツ

  • 名前や英語の単語: Khatt はアラビア文字のみ描画します。まず音訳してください(Sara → سارة、Kamangir → كمنجير)。綴りが複数考えられる場合は、レンダリング前にユーザーに綴りを確認してください。
  • Ramadan や Eid: lantern または gold 効果と night パレット、スタイルは naskh または ruqaa。
  • 結婚式や正式なカード: gold、rise または ink 効果;--layout mirror を試してください。
  • ロゴ: --still、スタイル kufi または blaka、--palette clear。
  • SNS投稿: アニメーション .svg はブラウザがある場所ならどこでも再生されます。動画が必要な場合は、MP4 をエクスポートするスタジオ(https://m-alkassem.github.io/khatt/)をユーザーに案内してください。
  • 短いテキストが最適です。長い文:line レイアウト、2行または3行。

可能な場合はユーザーのために結果を開いてください(macOS では open out.html など)。

新しいエフェクトを作成する

12の既存エフェクトが合わない場合(「文字を燃やして」「揺れるRamadanランタン」など)は、新しいエフェクトを作成してください。examples/ripple.mjs から始めます。エフェクトはインポートのないプレーンなオブジェクトです:

export default {
  id: "my-effect", name: "My effect", nameAr: "…", blurb: "…",
  palette: "night",          // デフォルトのパレットID
  loop: false,               // 動き続ける場合はtrue
  render(ctx) {
    // return { css, defs?, body, duration, poster? }
  },
};

render(ctx) は以下を受け取ります:

  • ctx.pieces:グリフごとに1つのエントリ:d(SVGパス)、order(読み順、0=最初の文字)、box {x0,y0,x1,y1}、cx、cy。鏡像コピーは同じorderを共有します。
  • ctx.steps、ctx.box(テキストボックス)、ctx.view(キャンバス全体)、ctx.em(フォントサイズ、100)、ctx.palette(bg、ink、accent)、ctx.rng()(シード付き乱数)。
  • ctx.stagger(order, spread?):文字の遅延、spread 秒に分散。
  • ctx.sample(piece, count):文字内のランダムな点。パーティクル用。
  • ctx.inside(piece, x, y)、ctx.area(piece)。
  • ctx.anim(name, seconds, { ease, loop, alternate }):クラス用のアニメーションCSS。
  • ctx.at(seconds, extraStyle?):要素の遅延を設定するインラインスタイル。
  • ctx.n(number):コンパクトな出力のための数値の丸め。
  • ctx.p:一意のプレフィックス。すべてのクラス、ID、キーフレーム名に使用します。

描画をどのフレームでも一時停止可能にするルール(静止画やビデオ出力はこれに依存します):

  1. すべてのアニメーション要素には class="${p}-a ..." と style="${at(seconds)}" を付けます。
  2. クラスルールには ctx.anim(...) を使用します。animation: のショートハンドを記述したり、animation-delay を自分で設定しないでください。
  3. キーフレームには ${p}-something という名前を付けます。要素に ${p}-b を追加すると、その要素の中心を基準に拡大・縮小または回転します。
  4. CSSプロパティのみをアニメーション化します(opacity、transform、stroke-dashoffset、fill-opacity など)。SMIL <animate> やスクリプトは正しくフリーズしません。
  5. 軽量に保ちます:最大でも数千要素程度にします。

次に実行します:

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

ユーザーが気に入ったら、プルリクエストとして https://github.com/M-Alkassem/khatt に共有することを提案してください(エフェクトは src/effects/ にあります)。

関連スキル