AI少女 BepinEx Zipmodファイルの作り方？(;^_^A
ハニセレを殆ど起動しなくなっちゃった 今日この頃～
もっぱらAI少女のプラグイン？の大半をなす～
BepinEx なるものの使い方というか～アイテムなどなどを登録する方法などを～
ちまちまとお勉強中！？
その中でも私が一番関わりそうな「zipmodファイル」なるものの
作り方を自身のメモも兼ねて記事にしちゃおうかと思いまする～。
っといいつつ～
「BepinEx」がいったい何をしているのか？っと言う事は私もまったく理解してなくて～
取敢えずプラグインをゲームへ簡単に導入できる装置っという事しかわかりません(;^_^A
まぁ その中で～
「Sideloader」なるプラグインが先ほどちらっと書きました「zipmodファイル」を読み込んでくれるプラグインの様です。
そして ここでわざわざzipmodファイルというものを作ってまでSideloaderプラグインを使うのかといいますと～
このプラグインを使いますと～
既存のゲームのフォルダー内にMODのファイルを追加しなくて済む上に～
MODファイルの抜き差しも簡単に済むからっという事なのですぅ
基本、Zipmodファイルは、ゲームフォルダー直下に「mods」フォルダーを設置し
その中にZipmodファイル（zipファイルでも可）を導入するという～いたって簡単なMOD導入方法になるため
MOD導入する際に色々悩まなくて済むことが多くなる利点がありますので～
AI少女ではこの方法でMODを作っていこうかなぁっと。
っとプラグインの説明はさて置き～本題をば
まずはZipmodファイルの中身はこうなってます。
なんでわざわざ7zipで開いてるかは後程解るとしまして～
zipmodファイルの第一階層目が上記のようになります。
「abdata」フォルダーはイリュ系の改造をしていればご存知の通り～
ゲーム内の各種ファイルが格納されているフォルダーですねぇ
そして、その下にある「manifest.xml」ですが
SideloaderがこのZipmodファイルを認識するための看板？になるファイルです。
まずは「abdata」フォルダー内なのですが～
基本的には、
●ゲーム内と同じファイル階層を構築してそこにMODファイルを配置
●その状態でzipmodファイルにパッケージする
上記がルールの様ですが 例外もいくつかありまして、
Listファイルに関してはリストをCVSファイルに記述した物でないと認識＆登録が出来ないようです。
他には、肌やサムネイルなどのテクスチャーを使う物の場合
テクスチャーのファイル名をしっかり個々に識別できるようにすれば
いちいちunity3dファイルに格納する必要は無いようです。
詳しい事はいつか記事を書くとして～まずは一番意味不明な～「manifest.xml」から～。
中に記載されているのはこんな感じ～
まぁ見れば大体わかりそうな内容ですよねぇ
Bepinの公式？では～最低限「＜guid＞～～～＜guid＞」さえあれば機能するという事らしいけど
出来るだけ記述しておいた方が後々自分で確認する場合にも役立つと思うので記述しときましょう～。
記述できる内容は、
＜guid＞#####＜guid＞ BepinEx内でのID #####は他のMODとなるべく被らない文字列
＜name＞#####＜name＞ MODの名前
＜version＞#####＜/version＞ MODのバージョン 「0.0.1」とか「1.2.3」とか～まぁ自分の思うバージョンの数字
＜author＞#####＜/author＞ MOD作者の名前やハンドルネーム
＜description＞#####＜/description＞ #####にMODの説明などを記述
＜website＞#####＜/website＞ MOD作者のブログやホームページ、DL先などのWeb上のアドレス（なければ省いちゃおう）
＜game＞#####＜/gam＞ このファイルが対象とするゲーム名
っと
記述できる内容はこのぐらいみたい
GUIDに関しては～最悪被ったとしてもBepinEx側で回避してくれるそうなので
うっかり被ってもよさそうではありますが～配布先の環境によってはIDのズレを起こすかもしれないので
出来るだけ被らないようにした方が良さそうですよねぇ
ちなみにGUIDですが～被らないために「作者の名前+MODの名前+ETC」っとしておくと被りにくいんじゃないかなぁ。
それと最後のゲーム名なのですが～漢字が入力可能かどうかが分からないので
おそらくアルファベット表記で書いた方が良いとは思う物の～記述しない方向に私はなりそうかなぁっと。
漢字やカタカナ、ひらがなに関しては、どの項目でも記述できるか試してないのでアルファベットで記述するのが無難かな？。
manifestはこれぐらいわかってればいけるかなぁ。
それでは LISTのCSVファイルの記述方法なのですが～
SCVファイルなので～エクセルでも編集出来ちゃいますってか～エクセルで書く方が楽かも。
まぁ そうは言いましてもまずはテキストエディターで中身を見てみよう～
※これはとある場所で配られているMODのなかのCSVファイルです。
上から
1行目 SB3Uで対象のリストを開いた時に[]内に記載されているナンバー
2行目 とにかく「0」 （特にBepinExでは読み込まれてないらしい行だけど～「0」記述が良いとのこと）
3行目 リストファイルの場所とファイル名 （実際に変更する箇所はリストファイル名ぐらいかと）
4行目 5行目以降の項目名
5行目以降 実際に登録するMODのIDや名前、パラメーター等
っとなっている模様
4行目以降はそれぞれの区切りを「,」で区切るのがCSVの書式の様ですねぇ
その4行目以降を編集する場合は～テキストエディターを使うよりはエクセルを使う方が楽かもしれません。
エクセルでCSVファイルを読み込むと「,」が区切りと認識され、自動的に別のセルに分けてくれますので
テキストファイルで編集する時の様に一々「,」を入れる必要が無いですし～
また、SB3Uで抜き出したTextAssetをエクセルで読み込みし～編集後CSVで保存すれば
タブで分けてた区分を「,」で別け直す作業もしなくて済むかも。
（この辺はまだやっていないので思う結果が得られるかは不明）
っとリストファイルを作る場合は、SB3Uで追加するMODが該当するリストを参照し
リスト自体のナンバー、ID、名前等々を既存のリストの書式で書けば追加出来そうですねぇ
さて～リストはこの辺にして～
その他にも～MODファイルにunity3dファイルを使用する場合の注意事項がありまして、
unity3dファイルのCABinetのIDを必ずゲーム内に存在しない値に変更する必要があります。
CABinet値が被りますとゲーム内に取り込まれません。
これは、ゲーム内に有る同じunity3dファイルを置き換える場合も例外ではなく値の変更が必要です。
さて 最後に～ZipModファイルとしてパッケージする方法を～っと。
上記を元に一通りMODが完成したと想定して～～
必要なファイルを一旦そのMOD名や配布用の名前などにしたフォルダーを
どこでもいいので作ってみましょう～。
こちらは先日、知り合いだけに人柱になって頂いたzipmodファイルの元のフォルダーです。
直上のフォルダー名は「[AI][HL]TestSkinSpec」っとなってますよね～
エクスプローラーでそのフォルダーを開いた状態が上記のSSです。
この状態で「abdata」フォルダと「manifest.xml」の両方を選択した状態で7zipにて圧縮をするを実行してみます～
するとこんなダイアログが出て来ますよねぇ
これの～圧縮形式を～zipに変えて～圧縮レベルを「無圧縮」、そして～圧縮名の後ろの拡張子を～「.zipmod」に書き換えます～
そして～圧縮すると～～～
こんな風に圧縮ファイル名は直上のフォルダー名でパッケージされちゃいます。
ちなみに～zipでパッケージした物の拡張子をzipmodに書き換えた場合、読み込まれない場合があるので
7zipでパッケージする際に拡張子をzipmodにしてから圧縮（パッケージ）する方が無難かと思います～。
そうそう 無圧縮でzipファイルを作る際、7zipが一番解りやすかったので7zipを使いました。
（まぁもともと使ってたってのもありますが）
あとは～このパッケージされたzipmodファイルを～ゲームフォルダー内にある～「mods」に放り込めば～読み込まれちゃいますぅ。
当然ですが無圧縮なので、MODの種類によっては容量が大きくなり～～～
アップローダーに載せる際は、7z形式等でしっかり圧縮すると良いかもですねぇ。
っと概要だけですが～こんな感じかなぁ
まぁテクスチャだけとか～サムネイルとか～他にも色々手順はあるんですけど～・・・・(;^_^A
とにかく～zipmod内のabdataフォルダ内は～ゲームフォルダー内と同じ構造にすれば良いっと
なんとな～く、覚えてればそれなりに出来ちゃう気もするなぁっと・・・・
それでは～～～～ものすごーく適当な説明記事を書いちゃうイトでしたっと。
もっぱらAI少女のプラグイン？の大半をなす～
BepinEx なるものの使い方というか～アイテムなどなどを登録する方法などを～
ちまちまとお勉強中！？
その中でも私が一番関わりそうな「zipmodファイル」なるものの
作り方を自身のメモも兼ねて記事にしちゃおうかと思いまする～。
っといいつつ～
「BepinEx」がいったい何をしているのか？っと言う事は私もまったく理解してなくて～
取敢えずプラグインをゲームへ簡単に導入できる装置っという事しかわかりません(;^_^A
まぁ その中で～
「Sideloader」なるプラグインが先ほどちらっと書きました「zipmodファイル」を読み込んでくれるプラグインの様です。
そして ここでわざわざzipmodファイルというものを作ってまでSideloaderプラグインを使うのかといいますと～
このプラグインを使いますと～
既存のゲームのフォルダー内にMODのファイルを追加しなくて済む上に～
MODファイルの抜き差しも簡単に済むからっという事なのですぅ
基本、Zipmodファイルは、ゲームフォルダー直下に「mods」フォルダーを設置し
その中にZipmodファイル（zipファイルでも可）を導入するという～いたって簡単なMOD導入方法になるため
MOD導入する際に色々悩まなくて済むことが多くなる利点がありますので～
AI少女ではこの方法でMODを作っていこうかなぁっと。
っとプラグインの説明はさて置き～本題をば
まずはZipmodファイルの中身はこうなってます。
なんでわざわざ7zipで開いてるかは後程解るとしまして～
zipmodファイルの第一階層目が上記のようになります。
「abdata」フォルダーはイリュ系の改造をしていればご存知の通り～
ゲーム内の各種ファイルが格納されているフォルダーですねぇ
そして、その下にある「manifest.xml」ですが
SideloaderがこのZipmodファイルを認識するための看板？になるファイルです。
まずは「abdata」フォルダー内なのですが～
基本的には、
●ゲーム内と同じファイル階層を構築してそこにMODファイルを配置
●その状態でzipmodファイルにパッケージする
上記がルールの様ですが 例外もいくつかありまして、
Listファイルに関してはリストをCVSファイルに記述した物でないと認識＆登録が出来ないようです。
他には、肌やサムネイルなどのテクスチャーを使う物の場合
テクスチャーのファイル名をしっかり個々に識別できるようにすれば
いちいちunity3dファイルに格納する必要は無いようです。
詳しい事はいつか記事を書くとして～まずは一番意味不明な～「manifest.xml」から～。
中に記載されているのはこんな感じ～
まぁ見れば大体わかりそうな内容ですよねぇ
Bepinの公式？では～最低限「＜guid＞～～～＜guid＞」さえあれば機能するという事らしいけど
出来るだけ記述しておいた方が後々自分で確認する場合にも役立つと思うので記述しときましょう～。
記述できる内容は、
＜guid＞#####＜guid＞ BepinEx内でのID #####は他のMODとなるべく被らない文字列
＜name＞#####＜name＞ MODの名前
＜version＞#####＜/version＞ MODのバージョン 「0.0.1」とか「1.2.3」とか～まぁ自分の思うバージョンの数字
＜author＞#####＜/author＞ MOD作者の名前やハンドルネーム
＜description＞#####＜/description＞ #####にMODの説明などを記述
＜website＞#####＜/website＞ MOD作者のブログやホームページ、DL先などのWeb上のアドレス（なければ省いちゃおう）
＜game＞#####＜/gam＞ このファイルが対象とするゲーム名
っと
記述できる内容はこのぐらいみたい
GUIDに関しては～最悪被ったとしてもBepinEx側で回避してくれるそうなので
うっかり被ってもよさそうではありますが～配布先の環境によってはIDのズレを起こすかもしれないので
出来るだけ被らないようにした方が良さそうですよねぇ
ちなみにGUIDですが～被らないために「作者の名前+MODの名前+ETC」っとしておくと被りにくいんじゃないかなぁ。
それと最後のゲーム名なのですが～漢字が入力可能かどうかが分からないので
おそらくアルファベット表記で書いた方が良いとは思う物の～記述しない方向に私はなりそうかなぁっと。
漢字やカタカナ、ひらがなに関しては、どの項目でも記述できるか試してないのでアルファベットで記述するのが無難かな？。
manifestはこれぐらいわかってればいけるかなぁ。
それでは LISTのCSVファイルの記述方法なのですが～
SCVファイルなので～エクセルでも編集出来ちゃいますってか～エクセルで書く方が楽かも。
まぁ そうは言いましてもまずはテキストエディターで中身を見てみよう～
※これはとある場所で配られているMODのなかのCSVファイルです。
上から
1行目 SB3Uで対象のリストを開いた時に[]内に記載されているナンバー
2行目 とにかく「0」 （特にBepinExでは読み込まれてないらしい行だけど～「0」記述が良いとのこと）
3行目 リストファイルの場所とファイル名 （実際に変更する箇所はリストファイル名ぐらいかと）
4行目 5行目以降の項目名
5行目以降 実際に登録するMODのIDや名前、パラメーター等
っとなっている模様
4行目以降はそれぞれの区切りを「,」で区切るのがCSVの書式の様ですねぇ
その4行目以降を編集する場合は～テキストエディターを使うよりはエクセルを使う方が楽かもしれません。
エクセルでCSVファイルを読み込むと「,」が区切りと認識され、自動的に別のセルに分けてくれますので
テキストファイルで編集する時の様に一々「,」を入れる必要が無いですし～
また、SB3Uで抜き出したTextAssetをエクセルで読み込みし～編集後CSVで保存すれば
タブで分けてた区分を「,」で別け直す作業もしなくて済むかも。
（この辺はまだやっていないので思う結果が得られるかは不明）
っとリストファイルを作る場合は、SB3Uで追加するMODが該当するリストを参照し
リスト自体のナンバー、ID、名前等々を既存のリストの書式で書けば追加出来そうですねぇ
さて～リストはこの辺にして～
その他にも～MODファイルにunity3dファイルを使用する場合の注意事項がありまして、
unity3dファイルのCABinetのIDを必ずゲーム内に存在しない値に変更する必要があります。
CABinet値が被りますとゲーム内に取り込まれません。
これは、ゲーム内に有る同じunity3dファイルを置き換える場合も例外ではなく値の変更が必要です。
さて 最後に～ZipModファイルとしてパッケージする方法を～っと。
上記を元に一通りMODが完成したと想定して～～
必要なファイルを一旦そのMOD名や配布用の名前などにしたフォルダーを
どこでもいいので作ってみましょう～。
こちらは先日、知り合いだけに人柱になって頂いたzipmodファイルの元のフォルダーです。
直上のフォルダー名は「[AI][HL]TestSkinSpec」っとなってますよね～
エクスプローラーでそのフォルダーを開いた状態が上記のSSです。
この状態で「abdata」フォルダと「manifest.xml」の両方を選択した状態で7zipにて圧縮をするを実行してみます～
するとこんなダイアログが出て来ますよねぇ
これの～圧縮形式を～zipに変えて～圧縮レベルを「無圧縮」、そして～圧縮名の後ろの拡張子を～「.zipmod」に書き換えます～
そして～圧縮すると～～～
こんな風に圧縮ファイル名は直上のフォルダー名でパッケージされちゃいます。
ちなみに～zipでパッケージした物の拡張子をzipmodに書き換えた場合、読み込まれない場合があるので
7zipでパッケージする際に拡張子をzipmodにしてから圧縮（パッケージ）する方が無難かと思います～。
そうそう 無圧縮でzipファイルを作る際、7zipが一番解りやすかったので7zipを使いました。
（まぁもともと使ってたってのもありますが）
あとは～このパッケージされたzipmodファイルを～ゲームフォルダー内にある～「mods」に放り込めば～読み込まれちゃいますぅ。
当然ですが無圧縮なので、MODの種類によっては容量が大きくなり～～～
アップローダーに載せる際は、7z形式等でしっかり圧縮すると良いかもですねぇ。
っと概要だけですが～こんな感じかなぁ
まぁテクスチャだけとか～サムネイルとか～他にも色々手順はあるんですけど～・・・・(;^_^A
とにかく～zipmod内のabdataフォルダ内は～ゲームフォルダー内と同じ構造にすれば良いっと
なんとな～く、覚えてればそれなりに出来ちゃう気もするなぁっと・・・・
それでは～～～～ものすごーく適当な説明記事を書いちゃうイトでしたっと。