instance-storage

ニコニコ生放送 (ニコ生ゲーム) においてローカルストレージを利用するための Akashic Engine 向けライブラリです。

利用には Akashic Engine v3 以降が必要です。

インストール

akashic install コマンドでインストールしてください。

akashic install @akashic-extension/instance-storage
Copy

インストール後にテキストエディタで game.json を開いて、次のような environment.external.instanceStorageLimited プロパティがなければ作成してください。 値は "0" としてください。(v2.1.2 以降の akashic-cli では、 akashic install 時に自動的に作成されます。)

{
  ...,
  "environment": {
    "external": {
      "instanceStorageLimited": "0"
    }
  }
}
Copy

利用方法

スクリプトアセット内で、 require() により値 instanceStorage を取得します。

const { instanceStorage } = require("@akashic-extension/instance-storage");
Copy

TypeScript の場合は import を利用してください。

import { instanceStorage } from "@akashic-extension/instance-storage";
Copy

const { instanceStorage } = require("@akashic-extension/instance-storage");

...

(async () => {
  const value = await instanceStorage.read("key1");
  console.log(`value: ${value}`);
})();
Copy

Promise の代わりにコールバック関数を渡すことができる instanceStorageRaw も利用できます。 (通常利用する必要はありません)

const { instanceStorageRaw } = require("@akashic-extension/instance-storage");

instanceStorageRaw.read("key1", (error, value) => {
  if (error) {
    console.log(error);
    return;
  }
  console.log(`value: ${value}`);
});
Copy

仕様

詳細な仕様は APIリファレンス を参照してください。

開発

ビルド方法

TypeScript で書かれています。ビルドには Node.js が必要です。以下のコマンドでビルドしてください。

npm install
npm run build
Copy

ライセンス

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

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