Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@akashic/game-configuration

akashic-games7.7kMIT2.5.0TypeScript support: included

Type definitions and utilities for game.json, the manifest file for Akashic Engine.

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/utilsrequire() してください。

var utils = require("@akashic/game-configuration/lib/utils");

...

var loadConfiguration = utils.makeLoadConfigurationFunc(loadGameConfiguration);
loadConfiguration(...);

テスト方法

npm test

ライセンス

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

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

changelog

CHANGELOG

2.5.0

  • BundledAssetConfigurationBundledTextAssetConfiguration を追加

2.4.0

  • GameConfigurationassetBundle を追加
  • AssetBundleConfiguration および BundledAssetConfiguration を追加

2.3.0

  • GameConfigurationrenderers を追加

2.2.0

  • GameConfigurationmoduleMainPaths を追加

2.1.0

  • GameConfigurationenvironment.features を追加

2.0.1

  • 不要となった es6-promise を削除

2.0.0

  • extractAssetPaths()audioExtensionResolver の戻り値の拡張子に "." を要求するように

1.12.0

  • makePathKeyObject() を追加

1.11.1

  • BinaryAssetConfigurationBase から data を削除

1.11.0

1.10.0

1.9.0

  • ScriptAssetConfigurationBasepreload を追加

1.8.0

  • GameConfigurationmaxPoints を追加

1.7.0

  • GameConfiguration#environmentniconico を追加
  • NicoliveEnvironmentpreferredSessionParameters を追加

1.6.0

  • AudioAssetConfigurationBaseoffset を追加

1.5.0

1.4.0

  • GameConfigurationenvironment を追加

1.3.0

  • GameConfigurationdefaultSkippingScene を追加

1.2.0

  • ImageAssetConfigurationBase#slice を追加

1.1.0

1.0.1

  • LoadGameConfigurationFunc の引数順を修正

1.0.0

  • 初期リリース