/js4kintro

javascript 4k intro template

Primary LanguageJavaScript

#js4kintro

javascript と WebGL、そして GLSL を用いて行う 4k intro のためのひな形ファイルやサンプルファイルを収めたリポジトリです。

現状ではひな形となるベースファイルの容量が約 1.3 キロバイトになっています。工夫次第で約 2.7 キロバイトほどフラグメントシェーダのコードが書ける状態です。 手っ取り早く体験してみたいという方は、オンラインでシェーダを編集して、ダウンロードすることも可能なエディタを用意しましたので使ってみてください。

オンライン js4kintro エディタ

なお、Twitter のハッシュタグはそのままですが #js4kintro です!

作品投稿イベントやります(気軽に参加してね!)

javascript 4k intro 作品掲載 特設ページ

js4k intro では WebGL + GLSL で記述された 4k intro 作品を募集しています! 「classic 部門」と制限なしの「nolimit 部門」の二つの部門を開催する方針で、ファイルの提出期限は今のところ 11月末日を予定 12月末日 を予定しています。

classic 部門では同じひな形を利用します。このひな形は HTML や javascript、CSS がすべて含まれており、その状態で最適化されて 1.3KB の容量です。つまり残りの約 2.7KB を GLSL のフラグメントシェーダに割り当てることができます。

最終的には、最適化前の状態のコードがあればそちら(必須ではないです)と、実際に 4k まで最適化したコード、両者を運営が受け取り専用の特設ページにて公開する予定です。

一方、nolimit 部門には制限はありません。ファイル容量制限なし、HTML や javascript なども独自実装可となっています。こちらも運営が受け取り公開する予定ですが、作者の実行環境(開発環境)で正しい動作をしている状態でのキャプチャ画像を撮っていただく場合があるかもしれません。

※ nolimit の場合は特に実行環境を限定するケースが多くなると思うので

作品の投稿はメールにて受け付ける予定です。作品を添付して admin[at]wgld.org まで送ってください。

ルール(各部門に共通の仕様)

  • 外部ファイルを参照せずに単独で動作すること
  • ライセンスの表記が必要なライブラリやコードを利用していないこと
  • オフラインで動作するように設計されていること
  • 最低でも 512px/辺 の矩形領域で動作することを保証すること
  • デスクトップ版の、その時点での最新の Chrome と FireFox で同じように動作すること

※ WebGL の場合、オンラインでブラウザで実行できますので動作環境については判断が難しいところです。最低限、Chrome と FireFox の最新版で動作確認をしてください。もし可能であれば、Windows 版と Mac 版の双方で確認していただけると公開後に閲覧できないというケースが減らせると思います。

classic 部門の仕様とルール

  • ひな形ファイルを元に作成しファイルサイズが 4096byte 以下であること
  • ひな形ファイルで修正を加えていいのはフラグメントシェーダの部分のみ
  • HTML には最終的にタイトル(titleタグ)を含めるがこれはファイルサイズにカウントしない
  • シェーダのコンパイルとリンクをチェックしておりエラーがある場合には動作しない
  • ブラウザのクライアント領域全面に canvas が自動的に最大化されます
  • window.onload で動作開始、ESC キーによって動作を停止します

nolimit 部門の仕様とルール

  • 無制限とはいっても最低限、WebGL と GLSL を利用して canvas にレンダリングすること
  • 画面に何もレンダリングされない(例えば音声のみなど)は不可

書いてみたくなったら

当リポジトリの src ディレクトリには、一切省略せずに記述した full 版と通常版の HTML ファイルが入っています。

それぞれに、デバッグ用のコードを追加したバージョンが別途付随します。デバッグ用のコードが含まれているバージョンでは、シェーダのコンパイルなどでエラーが起こった場合にその原因をアラートで画面に出力しますので最初のうちはデバッグ版を利用したほうが開発しやすいと思います。

尚、full 版にはプリセットのフラグメントシェーダのコードとして、ジュリア集合が描かれるサンプルが入っています。

また、オンライン js4kintro エディタを利用すれば、オンラインでシェーダを記述することができます。そのまま記述したシェーダを組み込んだ状態のファイルをダウンロードすることもできますので、気軽にチャレンジしてみてください。

作品が完成したら、メールなどで送っていただければ javascript 4k intro 作品掲載 特設ページにて随時公開していきます。

オンラインサンプル

オンラインサンプルは、Windows7(3.40GHz Intel Corei5-3570K+Intel HD Graphics 4000+メモリ8GB)、また MacBookAir(1.4GHzデュアルコアIntel Core i5+Intel HD Graphics 5000+メモリ8MB+13.3インチ) でも動作を確認しました。スクリーンサイズを 512px 四方の正方形にして実行するとほぼ処理落ちしないで動作しているように見えます。ただスクリーンサイズを 1400x900 程度に広げると前述の Windows マシンでは少々処理落ちが目立つようになります(特にレイマーチング系)。

その他、GLSL Sandbox や、手前味噌ですが wgld.org などを参考にするといいかもしれません。