【BeamNG drive】キーコンフィグの作り方 ～Mod作成記#6～

「Modやオリジナルのコマンドをキーボード／コントローラから操作したい！！」
ということがあったので、方法を調べてみました。

方法

方法はいたってシンプルで、キーコンフィグ用のファイルを作成する、たったこれだけです。

ファイルさえ作ってしまえば、通常のキー割り当てと同じようにオプション画面からキー割り当ての設定ができます。

※ここでは通常アクションの設定方法を紹介します。車両独自のアクションの設定については参考に記載のURLを参照してください。

１．キーコンフィグのファイルを作成

まずはキーコンフィグ用のファイルを作成していきます。

このファイルは、キー割り当ての対象にしたいアクション(Luaコマンドなど)を記載したファイルです。
このファイルを所定のフォルダに置いておくことで、ファイルに記載したアクションがオプション画面のCONTROLSで設定できるようになります。

ファイルは以下のフォルダに「○○.json」という形式で作成します。

ユーザフォルダ\AppData\Local\BeamNG.drive\0.25\lua\ge\extensions\core\input\actions

※フォルダがない場合は新規作成してください。
※「○○.json」の○○の部分は他のファイルと名前が被らないようにしましょう。

○○.jsonには、"アクション名" : {アクションの設定}という形式で、アクション毎に設定を記載します。

{
    "アクション名1": {
        (ここにアクションの設定を記載(後述の一覧参照))
    },
    "アクション名2": {
        (ここにアクションの設定を記載(後述の一覧参照))
    },
    ...
}

1ファイルに複数のアクションを記載することが可能ですが、アクション名はグローバルな名前空間で一意の名称とする必要がある点に注意してください。

アクション設定の部分は、かなり細かい設定になるのですが、一例としては以下のような記載になります。

{
    "thrill-drive-mod_crash_breaker": {
        "title": "Toggle Crash Breaker",
        "desc": "Explode player vehicle and other nearby vehicles.",
        "isBasic": true,
        "cat": "vehicle",
        "order": 1,
        "isCentered": false,
        "actionMap": "VehicleCommon",
        "ctx": "elua",
        "onDown": "mathkuro_thrillDrive.crashBreaker()"
    }
}

各項目の詳細については以下の一覧をご確認ください。

○○.jsonファイルを作成すると、オプション画面のキーコンフィグに追加したオリジナルのアクションが表示されます。

※もし追加したアクションが出てこない場合はCtrl+Lでリロードしてみてください。
(それでも表示されない場合は、設定かファイルパスが間違ってるかも)

２．キーコンフィグを設定

ファイルを作成したら、あとは通常通りゲーム内でキーコンフィグの設定を行うだけです。

Option -> CONTROLSを開き、追加したアクションを選択します。
+をクリックし、通常通りキーコンフィグを設定してください。

参考

Action Mapについて

Action Mapはキーコンフィグのグルーピングで、上述の”cat”(カテゴリ)に近いのですが、カテゴリがオプション画面上の分類なのに対して、Action Mapは実際の処理上での分類を表します。

デフォルトの分類は以下になりますが、独自の名前の分類を作成することも可能です。

参考URL

基本的には以下に全て書いてあります。
https://documentation.beamng.com/modding/input/