# VNAnime2 説明書
# VNAnime2ではゲーム内の説明部分を自作可能です。
# まず、#で始まる行はすべてコメントと解釈し、読み飛ばされる。
# ファイル名を"vnhelp_vnanime2_<ID>.txt"と付け、文字コードをUTF8して保存してください。保存場所はlibフォルダ内、vnanime2.pyの隣。
# ファイル名の中の<ID>部分は基本的に使用する言語をいればいい、例えば：EN, CH, JP
# ただし、実際にID部分に対して制限がありません。自分のIDでもなんでもOK、あんまり長すぎないようにね。
#
# 内容は基本的にテキストだけで、一部のHTMLタグが利用できます。例えば<color=#RRGGBB>色付き文字</color>、<size=20>サイズ指定文字</size>、<b></b>、<i></i>とか。
# もし自作した説明をVNGEパッケージに入れてほしいなら、KeitaroまたはCountd360に連絡してください。
#
# VNAnime2　説明要件:
# VNAnime2　説明は3か所の要件が必要: [[KeyframeView]]、[[DetailView]]及び[[SettingView]]、要件はUIの内容によって表示される、要件の行を変更しないでね。
#
# v1.3 - Countd360
# 日本語版
#


[[KeyframeView]]
<size=20><color=#00ff00><b>VNAnime2 v1.3へようこそ！</b></color></size>
見た目は以前のVNAnime Clipとほぼ同じが、コア部分を作り直した新作ですよ！

<color=#00ff00>基礎知識</color>
➤<b>VNAnime</b>：VNAnimeとはVNGameEngineのモジュールの一つで、キーフレームアニメーションの作成と管理を担当する。
➤<b>Clipクリップ</b>：VNAnimeモジュールの成果物のこと。キーフレームの集合と考えてください。VNAnimeは同じシーンに複数のクリップを作成し、同時または必要応じて再生させることが可能。
➤<b>Keyframeキーフレーム</b>：よく使う動画の方式、またはその動画を構成する基本の要素。知らないならググって。
➤<b>Target_Objectターゲットオブジェクト</b>：クリップの中にアニメ化したいものを指す。キャラ、道具、カメラ、マップなどのシステム情報、一部のプラグインデータまでサポートする。<color=#00ff00>[Add]</color>ボタンを使ってターゲットを追加するのはクリップ作成の最初のステップ。
➤<b>Propertiesプロパティ</b>：プロパティとはオブジェクトの位置や回転などなどの属性。ターゲットオブジェクトを追加後、右のキーフレームビューアにでそのオブジェクトのプロパティリストを展開できる。プロパティはターゲットオブジェクトによって内容が違う。また、一部のプロパティとほとんどのプラグインサポートはVNActorの設定フラグをONしないと表示されない。

<color=#00ff00>v1.3の新機能</color>
➤VNPhysicsのトリガー・アクションを実行できる。
➤新しい補完処理方式T。TモードはDモードと同じく値の補完はせず、キーフレームに当たった時のみ更新処理を行う。
➤ガベージコレクション（メモリ開放）が制御できる。Clipの開始・停止・ループする際にガベージコレクションを実行できる。Clipの再生中にガベージコレクションを実行させないことができる。キーフレームよりガベージコレクション実行ができる。

<color=#00ff00>v1.2の新機能</color>
➤Copy-To機能を実装。ターゲットオブジェクトのキーフレームを同種類のターゲットオブジェクトにコピーできる。
➤キーボードショートカットを実装。

<color=#00ff00>v1.1の新機能</color>
➤Ctrlキーを押している間、キーフレームの全選択、反転選択、縦選択と範囲選択機能をアクセスできる。
➤Shiftキーを押している間、キーフレームのシフト機能をアクセスできる。
➤キーフレームビュー内右クリックすれば、クリックした位置にキーフレームを登録できる。（Timelineもどき）

<color=#00ff00>VNAnime2の新しい特性</color>
➤すべてのプロパティのキーフレームが独立に動作するようになった！
➤IK/FKの調整もボーン独立で作成できる。
➤各プロジェクトに詳細な更新方法を設定できる。
➤カメラのプロパティも分割した。メインカメラとオブジェクトカメラの切替が可能。
➤クリップ操作がもっと使いやすい。別のClipと同期できる。
➤VNTextをクリップで制御可能
➤VNSoundをクリップで制御可能
➤キーボードショートカット追加
➤古いバージョンのクリップと共存できる。古いバージョンから新バージョンに変換可能（開発中）
➤計測していないが、古いバージョンより動作が軽くて早いはず。そうではないと感じたら連絡して。

<color=#00ff00>使い方のガイド</color>
➤最初のステップは<color=#00ff00>[Add]</color>ボタンをクリック、アニメ化したい対象を選択する。スタジオ内ほぼすべてのものが制御可能です。スタジオのワークスペースに表示されていないものも対応、例えばカメラやシステム、他のクリップなど。ワークスペース内の対象を選択した場合は、VNフレームワークに従いTagフォルダを生成する。VNに詳しくない場合"-"から始まった自動生成のフォルダを触らないこと。
➤キーフレームビューでアニメ化したいプロパティを選択する。ターゲットオブジェクト名をクリックすると全プロパティを選択、プロパティ名をクリックすると個別選択、Shiftキーを押して複数選択可。一般的なユーザケースでは全プロパティがいらないだろう。例えば移動したいならPositionだけでOK。どのプロパティがわからない場合は全部選択のもいいけど。
➤画面上のシークバー及ぼその直下のボタンで現在のフレーム位置を設定できる。キーフレームビュー内の緑の縦線に注意、それは現在のフレーム位置を表している。キーフレームビュー上部のフレーム番号をクリックしてフレーム移動もできる。
➤<color=#00ff00>[Register]</color>を押せば<color=#ff0000>現在選択中のプロパティを対象に現在のフレーム位置で</color>キーフレームを作成し登録する。なので、プロパティ選択していないとクリックできないし、複数選択した場合は一度に複数のキーフレームを作成できる。ただし、必ず同じフレーム位置に作成する（緑の線の上）。もし既存のキーフレームがあれば上書き。
➤キーフレームが一つだけではアニメにならない。フレーム位置を変更し、選択したプロパティの値を変更したら再度キーフレーム登録を行う。そうすればこの二つのキーフレームの間にVNAnimeが値を補間して動画になる。ただし、すべてのプロパティに補間アニメができるわけではない。値が離散のプロパティが多数存在する。例えば、口のパタン設定の場合、０とか１とかが設定できるが、1.5というパタンが存在しない。そうのような離散のプロパティの場合に値が次のキーフレームが到達するまで保持される。
➤キーフレームビューにある◆マークがキーフレームを表示する。クリックすれば選択できる。Shiftキー押して複数選択やマウスドラッグでボックス選択も可能。選択したキーフレームに対して<color=#00ff00>[Copy]</color>でコピー、<color=#00ff00>[Delete]</color>で削除できる。
➤キーフレームをコピーしたら<color=#00ff00>[Paste]</color>ボタンで現在のフレーム位置にペーストできる。もしフレームを跨って複数のキーフレームをコピーした場合、最初のキーフレームが現在のフレーム位置にペーストされ、残りのフレームがコビー時のフレーム間隔を保ったまま後ろに置かれる。
➤選択したキーフレームをドラッグで左右移動することも可能。左右移動がキーフレーム順番を変えることができない。また、大量のキーフレームを同時にドラッグ移動をしないでください。処理が遅いから。その必要がある場合は「コピー→削除→新しいところにペースト」の操作で処理する。
➤選択したキーフレームが補間可能のプロパティに属している場合に、補間カーブの設定サブ画面が表示される。二つのキーフレームの間の補間動作が後ろのキーフレームの補間カーブで決める。もし選択した複数のキーフレームに別のカーブ設定があれば、設定画面上にも複数のカーブが表示される。その時ハンドルよりのカーブ調節ができなくなり、プリセットでの設定のみになる。
➤一般的に、ターゲットオブジェクトの全プロパティをアニメ化したいとこがない。例えばキャラの位置だけとか位置と回転だけとか。その場合はオブジェクトの詳細設定で不要なプロパティを削除できる。オブジェクトを選択しリスト上部の<color=#00ff00>[>>]</color>ボタンで詳細ページを参照できる。また、<color=#00ff00>[Setting]</color>ページで使っていないプロパティを非表示することもできる。
➤クリップの長さや名前の調整や、編集画面全体の設定などについても<color=#00ff00>[Setting]</color>ページを参照。

[[DetailView]]
対象詳細設定ではターゲットオブジェクトのキーフレームに対して操作できる：
➤<color=#00ff00>Export</color>：選択したプロパティのキーフレームをJSON形式のテキストファイルにエクスポートする。
➤<color=#00ff00>Import</color>：JSONテキストファイルからキーフレームをインポートする。
➤<color=#00ff00>Copy To</color>:選択したプロパティのキーフレームを別のオブジェクト、または別のクリップにコピーする。
<color=#ffff00>✱注意</color>：ここの<color=#00ff00>Export</color>及び<color=#00ff00>Import</color>の対象はプロパティのキーフレームで、オブジェクトのID情報を含めない。なので、エクスポートしたキーフレームを別の同種類のオブジェクトにインポートが可能。
<color=#ffff00>✱注意</color>：<color=#00ff00>Export</color>と<color=#00ff00>Copy To</color>の対象は選択したプロパティのキーフレームが、もし何も選択していない場合は全プロパティを対象とする。

ターゲットオブジェクトのプロパティに対しても操作できる：
➤<color=#00ff00>Add</color>：新しいプロパティを追加する。プロパティ削除後また追加したいとかVNActorの設定で追加した場合に使用する。
➤<color=#00ff00>Delete Empty</color>: 空のプロパティ（キーフレーム一つもないプロパティ）を削除。空を消すことでUIが見やすくするし、動作もわずか早くなる。
➤<color=#00ff00>Delete</color>: 選択したプロパティを削除する。もしキーフレームが設定した場合は一緒に削除されるので注意を。

そして、下にはターゲットオブジェクトのプロパティ一覧である。プロパティ名をクリックすると選択・非選択できる。またバッチ選択ボタンも利用できる。
➤<color=#00ff00>All</color>：全部選択
➤<color=#00ff00>Empty</color>：空のプロパティを全部選択
➤<color=#00ff00>Invert</color>：選択状態を反転する
➤<color=#00ff00>None</color>：全部非選択

プロパティ一覧リストに名前の後ろの括弧の中は保有するキーフレーム数である。その後に更新方法に関する設定がある。（IK/FKボーンには個別の更新方法設定がない）
➤<color=#00ff00>auto/diff/force</color>：更新モード、適切なモードを設定することで更新回数を減らし、動作が軽くなる。<color=#00ff00>auto</color>モードは現在フレームの値と前回更新値と比較し、変化あれば更新。殆どの場合はこれで一番動作が軽い。<color=#00ff00>diff</color>モードは現在フレームの値とシーンの中の現在値を比較し、変化があれば更新。旧VNAnime1はこのモード。<color=#00ff00>force</color>モードは比較しない、毎回更新。不要な更新を行うと重くなるが、毎回必ず更新必要なキーフレーム設定なら逆にこれが一番（比較の手間が省ける）。
➤<color=#00ff00>«</color>：フレーム位置が最初のキーフレームの前の場合、更新するか否かの設定。
➤<color=#00ff00>»</color>：フレーム位置が最後のキーフレームの後の場合、更新するか否かの設定。
➤<color=#00ff00>A/C/D/T</color>：補間処理方式。Aは自動モード、連続キーフレームの間に補間処理がしない。Cは連続モード、連続でもその間に補完する。Dは離散モード、補完をしない。Tはトリガーモード、補完しない上、キーフレームに当たった時のみ更新する。離散プロパティはDかTモードのみ選択可能。二つのキーフレームが隣接し、その間に空きフレームがない場合は連続キーフレームという。
➤<color=#00ff00>↑/↓</color>：リスト内プロパティの順番。この順番はプロパティの更新順番であり、キーフレームビュー内の順番ではない！
<color=#ffff00>✱注意</color>：複数のプロパティを設定して、上記各設定を同時に調整できる。

[[SettingView]]
設定画面。クリップ全体とVNAnimeの全般設定が調整できる。

<b><Clip properties>グリッププロパティ</b>において:
➤<color=#00ff00>Name</color>：グリップの名前、IDとでもいえる。各グリップにユニークな名前が必須。他のモジュールや他のクリップから参照される。名づける時は文字を先頭にしてください、数値だけの名前がバッグになりやすい。
➤<color=#00ff00>Priority</color>：VNAnimeが複数のクリップを同時に再生することができる。もし再生中のクリップに同じターゲットオブジェクトの同じプロパティを設定しているなら、優先度の高いやつが勝ち。
➤<color=#00ff00>Auto run on load</color>：シーンロードしたら自動開始するかどうかの設定。
➤<color=#00ff00>Length</color>：クリップの総フレーム数。
➤<color=#00ff00>FPS</color>：一秒あたりのフレーム数。これは一秒内何個のキーフレームを置けるかの設定であり、クリップ再生時の更新レートの設定ではない！実際クリップ再生時の更新レートはゲームのFPSと一致し、パソコンの性能に依存する。
➤<color=#00ff00>Speed</color>：再生速度の倍数。上記のLengthとFPS設定と合わせて実際の実行時間を決定する。例：長さ300フレーム、30FPSのクリップは一般的に10秒がかかる、もし速度設定が2の場合は5秒で再生完了。
➤<color=#00ff00>Loop</color>：クリップのループ回数。注意したいのは再生の回数ではないこと。設定値が0の場合はループしない、即ち一回だけ再生する。設定値が1の場合は1回ループする、即ち計2回再生する。後は同様。-1を設定すると無限ループを意味する。
➤<color=#00ff00>Auto rewind when stop clip</color>:クリップを停止する時にフレーム0を再生するかどうか。エディタ画面の■ボタンは実は一時停止（||）ボタンなのでこの設定に影響されません。関連の停止（■）ボタンはクリップ管理画面にあります。ただし、このオプションをONにした場合、SSS/VNSSでf_clipstop指令を使用するとこのクリップのフレーム0が再生され、シーンが変化することがあるので注意していください。
➤<color=#00ff00>Do garbage collect</color>:クリップ開始・停止・ループする際にガベージコレクションを実行するかどうかを設定する。
<color=#ffff00>✱注意</color>：クリップのプロパティを修正したら<color=#00ff00>[Update Porperties]</color>ボタンで更新する必要がある。

<b><Clip operation>クリップ操作</b>において:
➤<color=#00ff00>Optimize</color>：不要のプロパティやキーフレームを削除して最適化する。開発中
➤<color=#00ff00>Export</color>：全クリップ内容をJSON形式のテキストファイルにエクスポートする。
➤<color=#00ff00>Import</color>：JSONテキストファイルからキーフレームをインポートする。（ターゲットオブジェクトのID/TAG付けが同じではないと動作しない）

<b><Global Setting>全般設定</b>において:
➤<color=#00ff00>Auto hide unused properties</color>：未使用のプロパティを自動的に隠すか否か。隠したら使うものに集中できる。
➤<color=#00ff00>VideoExport Mode</color>:このオプションをONにするとVideoExportのStart recording on next clickと連動できる。ただし、その時クリップ画面上のマウスクリックは画面ウィンドウ下のUI要素にも影響する。
➤<color=#00ff00>Suspend GC</color>:HS2/KKSのみ。いずれかのクリップが再生している場合、ガベージコレクションを実行させないようにする。ただし、ユーザー設定したガベージコレクション条件または設定したメモリ上限に達した場合は実行する。
➤<color=#00ff00>Editor window size</color>：編集画面の大きさ設定。最小サイズが500x265。
➤<color=#00ff00>Target panel width</color>：左側のオブジェクトリストの広さ。最小150、最大は編集画面の半分。
<color=#ffff00>✱注意</color>：VNAnime2では古い編集UI（Legacy mode）をサポートしなくなる。

<b><shortcuts>ショットカット</b>において:
➤<color=#00ff00>shortcuts</color>:ショットカットキーを設定できる。Ctrl/Shift/Altの組み合わせも可能。右クリックでキャンセル。
➤<color=#00ff00>Suspend-vanilla-studio-shortcut-keys</color>:Clip2クリップ編集中にスタジオ本来のショットカットキーを無効化するかどうか。Q/W/E/Rなど。
➤<color=#00ff00>Suspend-vanilla-camera-shortcut-keys</color>:Clip2クリップ編集中にカメラ制御用のショットカットキーを無効化するかどうか。方向キーなど。


