raycaster-js

raycaster-js は raycasting 法によってタイルマップを 3D 描画するソフトウェアレンダラーです。Akashic Engine上での利用を念頭に開発されていますが、単体での利用も可能となっています。

利用方法

Akashic Engineで利用する手順を説明します。

akashic-cliをインストールした後、

akashic install @akashic-extension/raycaster-js

でインストールできます。コンテンツからは、

var rc = require("@akashic-extension/raycaster-js");

で利用してください。

Akashic Engineの詳細な利用方法については、 公式ページ を参照してください。

サンプル

sample/ ディレクトリにサンプルが用意されています。詳細は各サンプルの README.md を参照してください。

APIリファレンス

https://akashic-games.github.io/raycaster-js/api/index.html

ビルド方法

raycaster-js は TypeScript で書かれたライブラリであるため、ビルドには Node.js が必要です。

npm install
npm run build

開発者向け

本ツールの publish について

• 以下の手順を踏むことで publish が行われます。
  1. package.json の version を更新したコミットを作成
  2. 1 のコミットで master ブランチを更新する
  3. GitHub Actions のリリースワークフローが実行される
• package-lock.json が原因で publish に失敗した場合は、npm i --before <実行時の7日前の日付(yyyy-mm-dd)> を実行して package-lock.json を更新し、再度 publish 処理を行なってください。

ライセンス

本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。

ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。