# @akashic/game-configuration

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

Latest version **2.5.0** (published 2024-12-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @akashic/game-configuration
pnpm add @akashic/game-configuration
yarn add @akashic/game-configuration
bun add @akashic/game-configuration
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.5.0 |
| Published | 2024-12-25 |
| First published | 2021-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 38.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | DWANGO Co., Ltd. |
| Maintainers | akashic-owner, yu-ogi, kmkr01, akashic-extension-owner, shinobu_takahashi |

## Links

- npm: https://www.npmjs.com/package/@akashic/game-configuration
- Repository: https://github.com/akashic-games/game-configuration
- Homepage: https://github.com/akashic-games/game-configuration#readme
- Issues: https://github.com/akashic-games/game-configuration/issues
- npm.io page: https://npm.io/package/@akashic/game-configuration

## Dependencies (1)

- [@akashic/pdi-types](https://npm.io/package/@akashic/pdi-types.md) ^1.14.0

## Recent versions

- 2.5.0 (latest) — 2024-12-25
- 2.1.0-beta.1 (next) — 2023-11-13
- 1.1.0-feature.0 (feature) — 2021-09-06
- 2.4.0 — 2024-11-19
- 2.3.0 — 2024-05-14
- 2.2.0 — 2024-03-06
- 2.1.0 — 2024-01-19
- 2.1.0-beta.0 — 2023-11-13
- 2.0.1 — 2023-07-31
- 2.0.0 — 2023-07-03
- 1.12.0 — 2023-06-27
- 1.11.1 — 2023-06-21
- 1.11.0 — 2023-06-19
- 1.10.0 — 2023-02-27
- 1.9.0 — 2023-01-26
- … 12 more at https://npm.io/package/@akashic/game-configuration/versions

## README

<p align="center">
<img src="https://raw.githubusercontent.com/akashic-games/game-configuration/main/img/akashic.png" />
</p>

# game-configuration
game.json の型定義および正規化処理を提供します。
**ゲーム開発者(Akashic Engineの利用者)がこのモジュールを直接利用する必要はありません**。

## インストール

Node.jsが必要です。次のコマンドでインストールできます。

```
npm install @akashic/game-configuration
```

## ビルド方法

TypeScriptで書かれています。インストール後にビルドしてください。

```sh
npm install
npm run build
```

## 利用方法

### 型として参照する場合

任意の TypeScript ファイル内でモジュールのルートを `import type` してください。

```javascript
import type {...} from "@akashic/game-configuration";
```

### game.json の正規化処理を利用する場合

`@akashic/game-configuration/lib/utils` を `require()` してください。

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

...

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

## テスト方法

```
npm test
```


## ライセンス
本リポジトリは MIT License の元で公開されています。
詳しくは [LICENSE](https://github.com/akashic-games/game-configuration/blob/main/LICENSE) をご覧ください。

ただし、画像ファイルおよび音声ファイルは
[CC BY 2.1 JP](https://creativecommons.org/licenses/by/2.1/jp/) の元で公開されています。

---
_Source: https://npm.io/package/@akashic/game-configuration · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._