基本前提 †
本ページでは、MODで触れられている「BepInEX」等に連動する追加プラグインの詳細を記載しています。
そのため、BepInEx自体の導入方法、並びに、MODを使用したことによるリスクについては、
前以てMODページで確認・理解をしている前提とします。
BepisPluginプリセット †
「BepInEX」で動作するプラグインのうち、プリセットで含まれるもの。
とはいえプレイスタイルによっては全く不要なものもあるので、適宜各自で取捨選択するように。
- BGMLoader.dll
ゲーム中のBGMを別の楽曲に差し換えできるプラグイン。
1.好きな曲のoggファイルを調達する(mp3からの変換ソフトはググれば出るのでここでは説明しない)
2.abdata\sound\data\bgmのファイル名を参考に「bgm00.ogg」のようなファイル名にする
3.BepInEx\BGMフォルダを作成し、oggファイルを入れる
通し番号がどのシーンのBGMに対応しているかは情報不足。追記求む。
- ColorCorrector.dll
画面エフェクトのブルームとLUTを切り替えるプラグイン。
F6でON/OFFする。意味がわからない人は入れないほうが無難だが、入れていて何か不都合があったという話もない。
解る人は詳しい話ヨロ。
- ConfigurationManager.dll
このdllが無いと、「Screencap」などconfig.iniの設定に依存して動作するプラグインが動かなくなる。
また、ゲーム中の設定画面の右上に「Plugin / mod settings」というボタンが追加され、そこからBepisプラグインの設定を一元管理できる。
- DeveloperConsole.dll
F12キーでデバッグメッセージを表示する。
プラグインが正常に読み込まなかった時などエラーメッセージが確認できるので、例えば進行不能になった際に、何の読み込みでつまずいたのかアタリをつけることができる。
なお、起動キー(F12)はconfig.iniで変更できる。
- DynamicTranslationLoader.dll
BepInEx\translationフォルダの内容に連動して、動的にゲーム中の単語の置き換えを行うプラグイン。
プラグイン名もフォルダ名も「translation(翻訳)」である通り翻訳プラグインとして取り扱われており、これを使って海外ユーザーは現地語版コイカツをプレイしている。
ということで、日本語が読めるユーザーならtranslationフォルダごと削除してしまって良いが、
自分で置き換えパターンを書き加えることで、「学生服(校内)」を「学生服(夏)」にしたり、
「のじゃっ子」を「ロリババア」に、「エクステ」を「アホ毛」に、ライティングのXとYを逆にしたりといったことが可能である。
他にもゲーム中の確認メッセージを好きなキャラの口調にしたり、
英語項目を追加するようなMODを使った時に、自分で翻訳して英語表記を日本語表記にしたりすることもできるだろう。
※例えばtranslationフォルダの中にtranslation.txtを置き、それに、学生服(校内)=学生服(夏)と書けば良い。
- ExtensibleSaveFormat.dll
セーブフォーマットを拡張するプラグイン。後述のSideloader他、特定のプラグインで使用されている。
本来無かったパラメータをいじるMODを使った際、普通にセーブしてもそもそもそんなデータを保存する仕様がない訳で、
そこでこのプラグインを使って無理やり保存させるわけである。
デメリットとして、これを導入した状態でセーブするとセーブファイルの互換性が失われるため、
このプラグインの利用者以外にデータを渡しても読み込みができなくなる。*1
各種コミュニティで自キャラカードを配布したい人には非推奨。
- InputUnlocker.dll
名前の入力制限を無くす。
キャラデータが非MOD導入者との互換性も無くなる恐れがあるので、必要なければ導入しない方が良い。
- IPALoader.dll
本来BepInEx及びBepisプラグインとは別の導入方法を用いていた「IPAプラグイン」を、BepInEx側で読み込むことが出来る。
IPA環境を別途構築する必要が無いので推奨。
このプラグインがある状態で、BepInEx\IPAフォルダを自分で作成し、そこにIPAプラグインを入れれば読み込まれる。
- MessageCenter.dll
画面左上にBepisプラグイン起因で出力されるログメッセージが表示される。
MOD導入起因で発生するトラブルの切り分けに役立つかもしれないが、スクショを撮ったよというだけでも表示されるため、邪魔であれば削除してよい。
- ResourceRedirector.dll
※ソースコードを読んだだけなので実際にこの通りの手順で動くか確かめてません
Koikatu/abdata-emulated フォルダを優先してアセットバンドルを読み込む機能。
あくまでも abdata フォルダにあるファイルを置き換えるだけなのでアイテムを新規追加するようなMODは反映されない。
- 例:abdata/chara/mt_cheek_00.unity3d の cw_t_cheek_005 の Texture2D なら Koikatu/abdata-emulated/mt_cheek_00/cw_t_cheek_005.png を置くとこちらに差し替わる。
AudioClip は .wav 、Texture2D は .png の2種に対応している。
- Koikatu/abdata-emulated/list/characustom フォルダに csvファイルを置くことで abdata-emulated フォルダにあるファイルを各カテゴリ(瞳、前髪、横髪など)として置き換えることができる。
- タイトルコール&ブランドコールを BepInEx/introclips フォルダに保存した wavファイルと置き換える機能がある。
※情報が古い可能性があるので試した方は追記ヨロ
- Screencap.dll
スクリーンショット機能を拡張し、F11で拡張スクリーンショットを、F9でUI入りのスクリーンショットを作れるようになる。
また、Shift+F11で拡張スクリーンショット用の設定ウィンドウを開ける(BepInEx\config.iniを直接編集しても良い)
config.iniの設定内容は本ページに別項を設けるのでここではざっくりと説明するが、
ウインドウサイズ以上のスクショを作れたり、キャラだけの透過pngを作れたり、キャラカードの画質を少しなめらかにすることができたりする。
つまり、Photoshop等で気合い入れて加工したい人やポージングツールとして使う人にはありがたみのあるプラグインと言える。
但し、従来のロゴ入り通常スクショは作成できなくなるので注意。
- Sideloader.dll
「zipmod」形式のMODを読み込めるようになるプラグイン。
このプラグインがある状態で、コイカツのインストールフォルダに「mods」というフォルダを作っておき、
その中にzipmod形式のMODを、拡張子がzip、またはzipmodのまま置くことで、そのMODがゲーム起動時に遅延読み込みされる。*2
なおzipmodの中身はabdataのフォルダ階層構造を含めた .unity3d あるいは .png 、 abdata/list/characustom の csvファイル、MOD作者情報などMOD識別用の manifest.xml で構成される。
ボディパーツや衣装追加関連が主だが、主流であった「abdataに直接ファイルをコピーする」タイプのmodと比べると、
・zip/zipmodファイルだけフォルダに放り込めば使えるので、導入・管理が非常にしやすい。
・IDを勝手に内部で補正するので、アイテムIDが公式DLCや他人が作成したMODと競合する心配がなくなる。
・瞳のテクスチャ等単純なTexture2DのみのMODであればunity3dに梱包する必要すらなくpngファイルのままパーツに追加できる。
といった利点がある。
特に2点目が重要で、追加パーツmodはゲームの未使用IDを使って出しているため、今後公式の追加要素とかちあわないとも限らない。
また、未使用IDといっても限りがあるので、いつかは頭打ちになる恐れがある。
更には、このSideloaderがあるためにMOD作者側が「IDを他者とズラすこと」に注力する必要がなくなり、IDの重複が起こりやすくなる。
上記から、既存modをzipmod化する動きもあったりする。
注意点としては、以下2点。
・このmod形式を利用して作ったキャラクターを他ユーザーに渡す場合には、受け取り側も同じ環境である必要があるため、仮に同じ衣装を持っていたとしても、abdate直接入れ込み派とは互換性を持たなくなる。*3
・本来の作者とは異なる人が既存modをzipmod化しているケースがあり、ちゃんと動かなかったり、元はあったはずのreadme.txtを消していたりと、信頼性の低いファイルも多い(特にMODまとめzipにありがち)。また、仮に動いたとしても、その後で本来の作者が追加版やバグフィックス版を非zipmod形式で上げた場合、それに対応するzipmodを探して削除する手間が生じる。そのため、基本的には本来の作者が採用している導入方法に沿うのが安全である。
- SliderUnlocker.dll
いわゆるワイドスライダー。キャラメイクの各ゲージ幅を-100~200に拡張することができる。
ちなみに、その数値はconfig.iniを編集することで更に拡張できる。
ただ、当然公式が想定しない値が入力されるわけで、効果が無いもの(髪の長さ)や、見た目が著しく壊れるもの(尻のサイズ)もある。
また、公式範囲外(0未満、101以上)へはマウスホイールでスライダーを動かすことができないので、ドラッグか数値直接入力で行うこと。
なお公式範囲外で保存されたキャラカードを非MOD環境で読み込むと、0または100に自動補正される。
BepinEx任意追加プラグイン †
多くの有志がBepInExで動作するプラグインを作成・配布している。
配布サイトは特定コミュニティ、アップローダー、個人クラウドなど多岐に亘り、個人のブログやSNSアカウントでひっそり発信されることもあるため、情報を見かけた人は追記ヨロ。
BepInプラグイン導入方法 †
大抵は、コイカツのインストールフォルダ>BepInExフォルダの中に、プリセットされたプラグイン同様ぶっこむだけで動く。
とはいえ、それぞれのプラグインのreadme.txtなどで解説されている場合はそちらを参照。
- Additional Skin Effects mod 【Discord #mod-sharing】(2019/1/10投稿)
スタジオの「状態」に、涙と同じ要領で、汗とぶっかけと処女喪失の表示項目を足す事が出来る。
後述のKSOXが必須。属性もあると思うのでこれを好むのかは難しいところだが、そういう拡張もできるということ自体が今後の発展への期待を持たせる。
なお、汗項目と処女喪失項目については、config.iniで項目自体のON/OFFができる。
- Boop mod 【Discord #mod-sharing】(2018/10/27投稿)
女キャラの乳や尻を触るとぶるんと揺れるようになる。それだけ。
現代社会のストレスに疲れた際などに。
- CheatTools 【Download】
ゲーム本編での各種パラメーターを参照・編集が出来る。
F12キーでON/OFFする。
- CrossFader 【Download】
Bero同梱のおまけプラグイン。Hシーンで体位の動作切換をスムーズにする。
ただしオナニーでゲージが上がらなくなる。また、口やまんからちんを抜いたときに一瞬ちんが引き伸ばされる。
】
- Demosaic 【Download
藻消し。ただし性器は標準では存在しないのでこれだけだと股間がツルツルになるだけ。性器を表示させる場合は別途性器MODの導入が必要になる。
- DragAndDrop 【ILLUSIONうぷろだ】
ドラッグ&ドロップでカード、シーンを読み込み可能にする。キャラメイク、スタジオで使用可能。
スタジオにおいては、前以て配置済みキャラを選択状態にしておくことで、キャラクターの「入れ替え」も行える。
しかし男女の入れ替えはまだ完全でなく、
「スタジオで男キャラ選択中に女カードを放り込むと、パラメータから算出された"男性の体型"として描画される(男体化する)」
「フリーHで女役に男カードを放り込めるが、"女性の体形"として描画される(女体化する)」
ということになる。
女キャラメイク中に男カードを放り込んでも女体化するわけで、考えようによっては、
web上で気に入ったキャラを簡単に性転換できる、という使い方もあるわけだが……
- ExtensibleSaveRemover 【ILLUSIONうぷろだ】
BepisPlugins同梱のExtensibleSaveFormatで拡張されたセーブファイルを非MOD環境でも読み込みできるようにセーブするプラグイン。
拡張領域へのセーブが必要なプラグインは機能しなくなる。
BepInEx4.0以降には対応していないので入れないこと。
- HeightBar 【Discord #mod-sharing】(2019/1/9投稿)
キャラメイクで高さを確認出来る平面を表示する。
平面には地面からの高さが表示され、平面の高さは調節が可能。
なお、これによると身長「0」は「152cm」で、1変動ごとに「0.25cm」加減という計算である。
導入による弊害としてIPAのKK_GaugeSliderなど一部のIPAプラグインが正常に動作しなくなるので併用はできない。
- KKABMPlugin 【Download】
追加ボーンの拡大縮小を可能にする。
つまりはキャラメイクで編集可能になる部位が増えるということで、
手だけ縮小したり、脚の長さを変えたり、眉毛の内側だけ伸ばしたりといった事が可能になる。
- KKPE 【Patreon】
スタジオにおいて、IK操作を補助するプラグイン。
導入するとスタジオの左下部メニューに「KKPE」ボタンが追加される。
そもそもIK自体使いにくいきらいがあるのであまり操作感は快適でないかもしれないが、
ポーズの左右入れ替え・対称化ができる上、乳房向き変更、髪型・スカートのめくり調整の使い勝手はよい。
BepisPluginsと依存関係があり、KKPE v1.1.0 では、BepisPluginsのExtensibleSaveFormat.dllが必須。
- KoikatuVRAssistPlugin 【Download】
公式VRの操作性を改善する。プラグインエラー暫定対応版のBepInEx.dllを同梱。
- MakerLag
キャラメイクでUI表示/非表示の切換時のラグを軽減する。
現在入手手段無し。
- ModDiscover 【ILLUSIONうぷろだ】
キャラメイクでメイク中のキャラが使用しているMODや、ワイスラ数値の項目を表示する
- Specter 【いつまでもプロトタイプ】
IPAプラグイン「ShortcutsKoi」の作者が制作中のスタジオ用MOD。
現時点で体の透明化、画面エフェクト拡張、ワンタッチ90度回転などが実装されている。
- SpecTest 【Download】
衣装のマテリアルで光沢を最大にする、要するにテカテカになる
水着使用時や濡れ表現にお勧めのプラグイン
- Unity Console for Koikatu 【Download】
CheatToolsよりも更に細かい部分まで編集できる
曜日変更、体型スライダー編集、時間ゲージ制御、会話ゲージ制御、などが更に編集出来る
- KSOX 【Download】
かつてKoiSkinOverlayと呼ばれていたもの。オーバーレイ画像を自前で用意し、キャラの体に反映させることができる。
つまり、ボディスーツ、全身タトゥー、体にラクガキ、涙、涎、体液、スパンキング痕などを作成・保存できる。
- キャラメイクの体項目にOverlayという項目が追加されているのでクリックする
- まずは「Get face overlay template」と「Get body overlay template」をクリックし、テンプレートファイルを生成する
- ペイントソフトなどで描き込む
- 描き込んだレイヤーだけ残した透過pngで保存する
- 「Load new texture」から保存したpngを選択する
なお、キャラメイクを開いたままでも該当pngファイルを更新すれば、即時キャラメイク上に変更が反映される。
config.iniの設定内容 †
とりあえず解る所だけ。追記ヨロ。
- com.bepis.bepinex.sliderunlocker
SliderUnlocker.dllに連動。ワイドスライダーの幅を変更する。
200以上は見た目が崩れやすく、スライダーも操作しにくくなるが、お好みで。
- com.bepis.bepinex.colorcorrector
colorcorrector.dllに連動。ブルーム(光のぼかし)の強さを調整。デフォルトは1。
5未満がせいぜい。それ以上はおすすめできない。
- com.bepis.bepinex.screenshotmanager
screencap.dllと連動する拡張スクリーンショット設定部。拡張スクリーンショットの生成内容をここで指定できる。
resolution-x=スクショの横幅
resolution-y=スクショの縦幅
downscalerate=
capturealpha=Trueにするとスタジオの作業用背景色や、キャラメイクでの背景が透過される
carddownscalerate=
Open_settings_window=設定画面を開く際の起動キー
Take_rendered_screenshot=拡張スクリーンショットを実行するキー
Take_UI_screenshot=UI入りスクリーンショットを実行するキー
- com.bepis.bepinex.developerconsole
DeveloperConsole.dllに連動。ShowKeyでコンソール起動ボタンを変えられるので、F12以外にしたい人はどうぞ。
Illusion Plugin Architecture †
略称は「IPA」。イリュージョンの従来作品に対して使われてきたIPAプラグインを動かすための構成物。
一応配布先を上記に載せたが、現状ではBepInExのIPALoaderプラグインでIPAプラグインを動かせるため、
既にBepInEx環境を構築する場合は改めて導入する必要はない。
IPA → BepInEx 切り替え時の注意点 †
先にIPAを導入していた場合、Managedフォルダ中の IllusionPlugin.dll が残っていると、BepInEx導入後に競合する可能性が高いので削除する必要がある。
IPAはパッチ解除すれば削除される。
パッチ解除するにはAltキーを押しながらKoikatu.exeをIPA.exeにドラッグすること。
BepInExでのIPAプラグイン導入方法 †
BepinExフォルダの中にプリセットのIPALoader.dllがある状態にし、
その後、BepinExフォルダの中にIPAフォルダを作り、その中にIPAプラグインを入れると動作するようになる。
本編VR化MODのkoikatuVRを導入する場合は、koikatuVR同梱のIPAを導入する必要がある。
IPAプラグイン †
- GameObjectList (ver.20180504a) Download
- Unityの GameObject をリスト表示する。
- マクロ機能有り
- KK_Kiyase Download
- トップスもしくはブラが装着された際に、胸のサイズを相対的に減算することが出来る。
- KK_GaugeSlider Download
- 男ステータス、Hゲージ、Hシーンでの感度など、各種ゲージをマウス操作可能にする
- UPPの Sybaris.IPA.Patcher ではHゲージのみ反応しない不具合がある
- BepInExの IPALoader では正常動作する
KoikatuVR †
Download
本編をVR化するIPAプラグイン一式
同梱のIPAも必要となる
他環境での導入方法 †
- UPP + BeplnEx + IPALoader.dllの場合
- Pluginsフォルダの中身をすべて /BepInEx/IPA に置く。
(/BepInEx/IPA/KoikatuVR.dll、/BepInEx/IPA/VR/SpeechTransport.dll 等のパスになる)
- /IPA/Data/Pluginsフォルダをフォルダごと/Koikatu_Dataに置く。
(/Koikatu_Data/Plugins/x86_64/openvr_api.dll 等のパスになる)
- 残りのファイル(IPA.exe、Mono.Cecil.dll、/IPA/Launcher.exe、/IPA/Data/Managedフォルダ)は不要。
Unity Pre Patcher †
略称はUPP。Unity製のゲームにパッチをあてることにより、ゲームデータを上書きすることなく各種プラグインの実行を可能とする。
つまり、ゲーム本体のデータをバニラ状態のままに各種MODが導入できるため、大量にMODを導入して管理が大変な人に恩恵が多い。
- 利点
- ゲーム本体のデータに手を加えないので、公式のアップデート後にMOD環境の再構築をする手間が省ける。
- UnityInjector、BepInEx、IPAの各種プラグインを読み込むことが出来る。つまりこれらのプラグインを改造せずに導入できる。
- プラグインによってMOD有り、無しの状態を任意選択してゲームを起動することが出来る様になる。
- ゲームフォルダからMODデータを取り除くのが容易。
- 欠点
- やや上級者向け。
- 導入が非常に面倒。
- MODに不具合が生じた場合、精査に時間が掛かる。
- 特に各種プラグインの仕様等を理解している必要がある。
UPPプラグイン †
- Sybaris.UnityInjector.Patcher Download
UnityInjector プラグインを読み込み可能にする。
- Sybaris.BepInEx.Patcher Download
BepInExプラグインを読み込み可能にする。
- Sybaris.IPA.Patcher Download
IPAプラグインを読み込み可能にする。
ちなみにSybaris.IPA.Patcherが動作している環境ではBepInEx側のIPAフォルダは読み込まれない。
一部IPAプラグインが正常動作しない報告が上がっている(KK_GaugeSlider)
- Koikatu.ModLoader.Patcher ILLUSIONうぷろだ
abdataフォルダを上書きする形式のMODを規定のフォルダから一括で読み込み可能にする。
MOD毎にフォルダで管理できるので、管理が容易になる。
最新版にReadmeがない場合は旧版をDLすると入っている。
- Upp.PatcherSelector.Patcher Download
起動時に読み込むUPPプラグインを任意に設定した起動ショートカットを生成する。
- IPA.UnityInjector.ConsoleUtil Download
UnityInjectorの日本語ログ出力をIPAやBepInExで使えるようにしたプラグイン
- Sybaris.HotKeyFilterプラグイン Download
ホットキーフィルタープラグインをUnityゲーム汎用にしたもの
ゲーム内で使用可能なキーをプラグイン毎に一覧表示する
MODなどで使用しているキーも確認可能
複数のMODで競合しているキーも個別に操作できるので非常に便利
v0040からBepInExプラグインに移行した
- UPP.LogfileCleaner Download
UnityPrePatcherのlogsフォルダに、無限に溜まっていくログファイルを自動的に削除する