@akashic/game-configuration

中文文档
2.5.0发布于 2024/12/25MITTypeScriptCommonJS近 30 天下载 5161

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

原始使用文档
文档目录7 节
  1. インストール
  2. ビルド方法
  3. 利用方法
  4. 型として参照する場合
  5. game.json の正規化処理を利用する場合
  6. テスト方法
  7. ライセンス

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 の元で公開されています。

版本与发布记录

@akashic/game-configuration 共发布 27 个版本,首次发布于 2021/01/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.5.0latest2024/12/251.9 年前
2.4.02024/11/202 年前
2.3.02024/05/142 年前
2.2.02024/03/062 年前
2.1.02024/01/192 年前
2.1.0-beta.1next2023/11/132 年前

其他发布通道:feature → 1.1.0-feature.0,next → 2.1.0-beta.1。

关于 @akashic/game-configuration 的常见问题

@akashic/game-configuration 是什么?

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

如何安装 @akashic/game-configuration?

在项目目录运行 npm install @akashic/game-configuration,或使用 pnpm add / yarn add / bun add。

@akashic/game-configuration 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@akashic/game-configuration 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@akashic/game-configuration 可以商用吗?

@akashic/game-configuration 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@akashic/game-configuration 的下载量有多少?

根据 npm 官方下载统计,@akashic/game-configuration 在 2026/10/06 – 2026/11/04 这 30 天内被下载 5,161 次,日均约 172 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@akashic/game-configuration 还在维护吗?

最新版本 2.5.0 发布于 2024/12/25(1.9 年前);至今共发布 27 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/01/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。