アニムを作成する
アニムは、1つのファイル(<ケバブ-名前>@<メジャー>.<マイナー>.yaml)で構成され、正確に4つのキーを持ちます。t(リテラルc)、j(ESモジュール)、s(CSS)、h(HTML/SVG)です。ホストプレイヤーは、グローバルなG APIを使用して、曲のシラブル、ワード、ライン、セクション、ビートを配信します。あなたの仕事は、ブリーフを元に、シーク/ポーズ/リサイズ/テーマで正しく動作し、読みやすく、美しいファイルを作成することです。以下のパスは、このs killl/ディレクトリからの相対パスです。
最も重要なルール
- フレームは再生時間の純粋な関数です。
render(t)は、再生がtに達した場合でも、ユーザーがそこにスクラブした場合でも、同じ画像を描画する必要があります。Math.random、Date.now、累積された積分、シークでスキップされる「前のフレームで何が起こったか」の状態は使用しないでください。すべてを曲データ、シード、tから導出します。 - 2つの半分。 バナーコメントの上に、エクスポートされたDOMフリーの純粋な半分 (
buildPlan、frameAt、ヘルパー、単体テスト可能) を配置し、その下に薄いブラウザ半分 (export default function (G, shadowRoot, config)) を配置します。これは配線と描画のみを行います。guides/architecture.mdを参照してください。 defaultで登録し、INITで曲データを読み取ります。G.on/G.off/G.onFrameはdefault内でのみ使用します。G.map/forEach/lookup/iterator/relayoutは、INITが発火した後 (INITハンドラ、またはrenderなどの後続のコールバック) でのみ使用し、default自体では使用しないでください。再生にはG.on(G.TYPE.TICK, render)で購読します。G.onFrame({ render, reset })は SEEK/PLAY/PAUSE/RESIZE および UNINIT をカバーします。G.dispose/G.listenでクリーンアップします。defaultから返された関数は無視されます。WebGL (forceContextLoss)、リスナー、タイマー、カメラを解放します。- 色は
c.vではなくCSSに記述します。:hostに明るいテーマの値を、[data-bs-theme=dark] { }に暗いテーマの上書きを記述します。キャンバスはg-libcssColorsでそれらを読み取ります。両方のテーマが意図的に見える必要があります。 - g-libに既にあるものは自分で実装しないでください( clamp、lerp、easing、決定論的RNG、キャンバスフィッティング、スプリング、テキストレイアウト、プールなど)。正確なタグのピン からインポートしてください。ヘルパーを書く前に
pitfalls/dont-hand-roll.mdとspec/g-lib.mdを確認してください。 - 可読性はエフェクトよりも優先されます。 アクティブなシラブルは、明るいテーマと暗いテーマの両方で、スマートフォンとラップトップの両方で、長い行、CJK、RTL、ミャンマー語で読み取り可能でなければなりません。大きなフラッシュは3Hz未満に抑えます (
guides/accessibility.md)。 - タイプ付きオプションは少数にします。
cとcSchemaはプレーンなリテラルです。各オプションは目に見える何かを行います。
ワークフロー(リポジトリツールを使用する場合)
- ブリーフ。
guides/design-brief.mdからデザインブリーフを作成します。1つの強力で物理的な絵、メカニズム、どのイベントが何を駆動するか(同期マップ)、構造(バース/コーラス/ビート)、可読性計画、オプション、落とし穴を含めます。選択テーブルを使用してバックエンドを選択します。可読性を維持できないアイデアは却下します。 - スキャフォールド。
npm run new -- <name> --backend canvas2d|svg|dom|threeを実行するか、templates/<backend>.yamlを手動でコピーして__NAME__を置き換えます。 - 一度読んでください。
spec/module-format.md、pitfalls/general.md、あなたのバックエンドのpitfalls/backends.mdのセクション、pitfalls/dont-hand-roll.md。下のルーティングテーブルを通してのみ、他のものを開いてください。 - 実装 最初に純粋な半分(時間から状態へ)、次に薄いブラウザ半分を実装します。
- 検証。
npm run validate -- anims/<file>.yamlを実行します。すべてのエラーを修正し、すべての警告をdocblockで正当化するか、修正します。 - チェック。
npm run check -- anims/<file>.yamlを実行します。13のエッジケースの曲をヘッドレスでマウントし、適合テーブルをスコアリングし、PNGをout/<name>/に書き込みます。PNGを開いてください(スマートフォン/ラップトップ、明るいテーマ/暗いテーマ)。醜い、または読みにくいフレームの上に緑色のテーブルがある場合は失敗です。シーク純度の行にWARNがある場合、画像が履歴に依存していることを意味します。修正するか、docblockで正当化します(意図的なシミュレーション)。 - プレビュー (オプション)。
npm run preview -- anims/<file>.yamlを実行して、再生、スクラブ、テーマの切り替え、オプションの調整を行います。 - レビュー
guides/quality-rubric.md(20の質問) に照らしてレビューし、1つのYAMLファイル と短いレポート(ファイル名、最終チェックテーブル、ブリーフが未解決のままにした決定事項、意図的に行わなかったこと)を納品します。out/やハーネスを出荷しないでください。
ツールなしモード(チャットモデル、シェルなし)
ステップ2、5~7をスキップします。一致するテンプレートテキストから開始し、推論の中でデザインブリーフを書き、応答する前に pitfalls/general.md、バックエンドセクション、20の質問のルーブリックを自分のコードに照らして1行ずつ確認します。1つのYAMLファイルのみを1つのフェンスで囲まれたブロックに出力し、実行せずに確認できなかったルーブリック項目(シーク純度、テーマ切り替え、リサイズ)を記載します。
ルーティングテーブル:トリガーが該当する場合のみドキュメントを開く
| 以下のことを行おうとしている場合… | 読むドキュメント |
|---|---|
| 何を構築するか決める、バックエンドを選択する | guides/design-brief.md |
| ファイルをレイアウトする、ステージに名前を付ける、docblockを書く | guides/architecture.md |
G.* 呼び出し、イベントオプション、ID範囲を使用する | spec/events.md、spec/event-shapes.md、spec/g.d.ts |
| オプション、色、テーマを追加する | spec/config.md |
| 時間ユーティリティ、テキスト測定、キャンバスヘルパー、ライフサイクルを使用する | spec/utilities.md |
| 行を表示行に分割する、テキストを折り返す | spec/relayout.md、guides/patterns-text.md |
| シラブル/行/ビートで何かをトリガーする、事前スポーン、ポーズ、スプリング | guides/patterns-timing.md |
| テキストをフィット、ハイライト、スタイル設定する、非ラテン文字 | guides/patterns-text.md |
| レンダリングコードを書く(DOM、SVG、キャンバス、three、シミュレーション、レイヤー) | guides/patterns-render.md、pitfalls/backends.md |
| カメラ、地形、群衆、パッキング、プロシージャル3D | guides/techniques.md、pitfalls/techniques.md |
| 写真やカメラを使用する | spec/image-input.md |
| ゲームを構築する(autoPlay false、スコア、状態) | guides/games.md |
| g-libヘルパーを使用する | spec/g-lib.md |
| フラッシュ、モーション、コントラストについて不確かな場合 | guides/accessibility.md |
| 終了する | guides/quality-rubric.md |
最小限の形状(これを出荷しないでください。テンプレートから開始してください)
"t": |-
c
"j": |
import { hash01 } from 'https://cdn.jsdelivr.net/gh/prjctg/[email protected]/index.js';
/* [email protected]: <1行>
* 1. <番号付きのデザインクレーム:メカニズムと、それが拒否する魅力的な間違った答え> */
export function frameAt(plan, t) { /* 純粋 */ }
/* ブラウザ半分。この行より上のすべては、意図的にDOMフリーです。 */
export default function (G, shadowRoot, config) {
const cfg = G.cfg(config, { channel: G.cfg.int(0) });
let ready = false;
const render = (t) => { if (!ready) return; /* frameAt(plan, t) を描画 */ };
G.on(G.TYPE.INIT, () => { ready = true; /* G.map(...) はここで有効 */ });
G.on(G.TYPE.TICK, render);
G.onFrame({ render, reset() { ready = false; } });
}
export const c = { v: { fadeMs: 150 }, m: [{ s: 'fadeMs', t: 'fadeMs' }] };
export const cSchema = [{ i: 'fadeMs', n: 'Fade (ms)', t: 'int', mn: 0, mx: 2000 }];
"s": |
:host { display: block; --ink: var(--inkColor, #111); }
[data-bs-theme=dark] { --ink: var(--inkColor, #eee); }
"h": |
<canvas id="c"></canvas>
j、s、h は生のテキストを保持します(バッククォートや引用符で囲まれていません)。t は |- を使用します。ファイル名はバージョンを保持します。公開されたバージョンをその場で編集しないでください。