@akashic/akashic-engine

The core library of Akashic Engine

Usage no npm install needed!

<script type="module">
  import akashicAkashicEngine from 'https://cdn.skypack.dev/@akashic/akashic-engine';
</script>

README

Akashic Engine

JavaScriptゲームエンジン Akashic Engine のコアライブラリです。 ゲーム開発者向けの環境非依存なクラス群を提供します。

利用方法

このリポジトリは、環境非依存なコードのみを含むライブラリです。そのため単体で利用することはできません。 ゲーム開発には Akashic Sandbox と Akashic CLI をご利用ください。 Akashic Engineの詳細な利用方法については、 公式ページ を参照してください。

TypeScript での型定義の利用

TypeScriptでゲームを開発する場合には、型定義ファイルとしてこのリポジトリの index.runtime.d.ts を使うことができます。 npm install -D @akashic/akashic-engine でインストールの上、 tsconfig.json で node_modules/@akashic/akashic-engine/index.runtime.d.ts を参照するなどの方法で、 tsc に与えてください。

ビルド方法

Akashic EngineはTypeScriptで書かれたJSモジュールです。ビルドにはNode.jsが必要です。 リポジトリ直下で次を実行してください。

npm install
npm run build

テスト方法

npm test

ライセンス

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

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