@akashic/game-configuration
v2.4.0
Published
Type definitions and utilities for game.json, the manifest file for Akashic Engine.
Downloads
3,516
Keywords
Readme
game-configuration
game.json の型定義および正規化処理を提供します。 ゲーム開発者(Akashic Engineの利用者)がこのモジュールを直接利用する必要はありません。
インストール
Node.jsが必要です。次のコマンドでインストールできます。
npm install @akashic/game-configuration
ビルド方法
TypeScriptで書かれています。インストール後にビルドしてください。
npm install
npm run build
利用方法
型として参照する場合
任意の TypeScript ファイル内でモジュールのルートを import type
してください。
import type {...} from "@akashic/game-configuration";
game.json の正規化処理を利用する場合
@akashic/game-configuration/lib/utils
を require()
してください。
var utils = require("@akashic/game-configuration/lib/utils");
...
var loadConfiguration = utils.makeLoadConfigurationFunc(loadGameConfiguration);
loadConfiguration(...);
テスト方法
npm test
ライセンス
本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。
ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。