qitana / act_dfaplugin

FFXIV Duty Finder Assist for ngld/OverlayPlugin

ACT_DFAPlugin

The add-on of ngld/OverlayPlugin which shows Duty Finder status.

DutyFinder(コンテンツファインダー) のステータスをオーバーレイ表示する、ngld/OverlayPlugin のアドオンです。

日本語の説明はこちら / README for ja-JP is here

Requirements

• ngld/OverlayPlugin

Features

• Displayed when the roulette name and dungeon name have been determined.
  • Also be notified by text-to-speech.
• Displays the queue position and estimated waiting time.
  • The actual queue position is displayed even if the number of waits is 50 or more.

How to use

1. Install ngld/OverlayPlugin.
2. Download DFAPlugin from release page and extract it to any folder.
   It is recommended that you create and place a separate folder with other plugins.
3. Install DFAPlugin as an ACT plugin.
4. Restart ACT once.
5. Confirm that DFA EventSource is added to the OverlayPlugin setting screen.
6. Add an overlay with OverlayPlugin. Select "MiniParse" as the type.
7. On the setting screen, set the URL to https://qitana.github.io/ACT_DFAPlugin/dfa.html.
8. Adjust the installation position and size, and lock when the position is determined.
   When locked, the overlay will not be displayed, but will only be displayed when using the Duty Finder.

Other overlay type

visit https://qitana.github.io/ACT_DFAPlugin/.
Please feel free to contribute another your overlay!

Special thanks

The algorithm refers to easly1989/ffxiv_act_dfassist.

Japanese

注意事項

v2.x からは ngld/OverlayPlugin でないと動きません！hibiyasleep/OverlayPlugin では動きません！
また、ngld/OverlayPlugin と hibiyasleep/OverlayPlugin は併用できません！

• kagerou等の今までのオーバーレイは ngld/OverlayPlugin でも動作します。
• hibiyasleep/OverlayPlugin のアドオンは ngld/OverlayPlugin では動きません。

できること

• 突入場所が判明した際にルーレット名およびコンテンツ名をTTSで通知できます。
• ネットワークデータで待ち人数/更新時間が更新(1分間隔)され次第、表示が更新されます。
  ゲームクライアントでは、データ到着から30秒後に1個前のデータとの中間値を表示しています。
  (おそらく変化を緩やかにするためだと思われます。)
• 待ちが50番以降でも、実際の待ち人数が表示されます。
• あと何分でシャキりそうか、残り時間が表示されます。(開始時間と待ち時間から計算しています。)
• シャキった後、突入を押す前でもロール毎のパーティ編成状況が分かります。

特徴

• 実体は ngld/OverlayPlugin の EventSource プラグインです。
  これを導入することで、オーバーレイで DutyFinder (コンテンツファインダー) のデータが扱えるようになります。
• FFXIV_ACT_Pugin が取得したネットワークデータを使用して処理しています。
• パッチ毎に変更されるOpcodeに対応するため、Opcodeの設定を外部ファイルにしているので、
  大きな変更がされない限りは、プラグインをアップグレードせずに使用可能です。
  最新のOpcode設定ファイルが更新されれば、起動時に自動で読み込まれます。
• Opcode を確認するための Trace 機能があります。
• 主に日本語の難読なダンジョン名称にTTSが対応できないことが多いため、
  TTS補助用の読み仮名変換を外部ファイルで設定しています。
  このデータも、起動時に自動で最新のファイルが読み込まれます。
  おかしな読みが発声した場合は PR/Issue で教えて頂けると助かります。

インストール方法

1. ngld/OverlayPlugin をACTのプラグインとして導入します。
2. Release から DFAPlugin をダウンロードし、任意のフォルダに展開します。
   他のプラグインと同じフォルダに入れないよう、別フォルダを作って配置することをおすすめします。
3. DFAPlugin を ACTのプラグインとして導入します。
4. DFAPlugin を OverlayPlugin に認識させるため、一度ACTを再起動します。
5. OverlayPlugin の設定画面に DFA EventSource が増えていることを確認します。
6. OverlayPlugin で オーバーレイを追加します。種類は MiniParse を選びます。
7. 設定画面でURLを https://qitana.github.io/ACT_DFAPlugin/dfa.html に設定します。
8. 設置位置や大きさを調整し、位置が決まったらリサイズ/変更が出来ないようにロックします。
   オーバーレイは見えなくなりますが、コンテンツファインダーを使用した際だけ表示されるようになります。

謝辞

マッチングのコードは easly1989/ffxiv_act_dfassist で使用されているコードを参考にしています。

よくある質問

CFで申請しても表示されない

いくつか考えられますが、以下を確認して下さい

• オーバーレイのURLを正しく設定できていない
• オーバーレイを表示するにチェックがはいっていない
• FFXIV_ACT_Plugin をメモリオンリーで使用している

日本語環境なのに表示やTTSが英語になる

FFXIV_ACT_Plugin の言語設定が日本語になってるか確認して下さい。

コンテンツファインダーを使用していない時は隠したい

「移動とサイズを制限する」のチェックを入れて下さい。

オーバーレイが見えないので位置が決められない

レイアウト用に表示したいときは 「移動とサイズを制限する」 のチェックを外して下さい。
このチェックを外すと、全ての項目が表示されます。
レイアウトが定まったら 移動とサイズを制限する」のチェックを入れて下さい。

For Developers

develop ブランチは私の作業用ブランチです。
不定期に rebase および push --force することがありますので、develop を追従しないようご注意下さい。

act_dfaplugin's Issues

Disable TTS option?

Hello!
I don't really need the audio for this plugin and was wondering if there is a option to disable TTS for it?
Thanks!
Edit* Never mind this, I forgot to look at the DFA event source. I see you can disable it there by removing the ${matched} code.

What do I need to change if I want to support other client versions?

For example, support for lower versions of South Korea, China. What do I need to do to fit in?

Support for Patch 5.15

大きな変更がされなければ、クライアント側のバージョンアップ等はない予定です。
ネットワークコードの変更だけであれば、こちらで定義ファイルを書き換えれば終わります。

Patch 5.15 に関しての連絡はここで行います。

Seeking for releases

there's no releases published :(

Errors adding to ACT

receiving these errors when attempting to add to ACT

DFAPlugin.cs
Line: 38 - (CS1002) ; expected
Line: 40 - (CS1002) ; expected

Strange numbers are displayed when Duty Finder with undersized party or TRUST system

人数制限解除やフェイスで人数表示がおかしくなる。
#1 にて @katabame さんに表示上のマスク処理を追加して頂きました。

根本の解決には人数制限解除のようなロールフリー申請を判別できるようにする必要がある。

Support for Patch 5.18

can't unzip file

i can't unzip the 7z file so i can put it into ACT. what should i do?

Wait Time displays 0 when over 30 mins

30分以上と表示されている場合に0分の表記になる。
30分以上と表記されているときは、ネットワークデータ 0 が送られてきていることが原因

Support for Patch 5.2

Not working in 5.31

I pulled the latest changes and the overlay is still not showing in 5.31 at all.

5.41 bug

5.41更新でビルドしたところ、CF/RFを使用していないにも関わらず突如としてリェーギア祭殿にマッチしたオーバーレイ・読み上げが発生します。
ビルド時のThirdParty以下を全て最新にして再ビルドしましたが変わりありません。

FFXIV_ACT_Plugin.dll　2.0.7.7
OverlayPlugin.dll 0.16.5.0

[2021/01/14 11:44:10] Info: DFA: Matched: Tank:0/0 Healer:64/0 DPS:149/43 NonRole:49/16
[2021/01/14 11:45:17] Info: DFA: ZoneChanged: 534, Twin Adder Barracks
これはミラドレを使用していた際に発生したのを確認しています。

直近ログ
[2021/01/14 0:37:19] Info: AssemblyResolver: Loaded: Newtonsoft.Json, Version=12.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed
[2021/01/14 0:37:19] Info: AssemblyResolver: Loaded: websocket-sharp, Version=1.0.2.32519, Culture=neutral, PublicKeyToken=5660b08a1845a91e
[2021/01/14 0:37:19] Info: AssemblyResolver: Loaded: HtmlRenderer, Version=0.16.5.0, Culture=neutral, PublicKeyToken=null
[2021/01/14 0:37:19] Info: AssemblyResolver: Loaded: CefSharp, Version=75.1.141.0, Culture=neutral, PublicKeyToken=40c4b6fc221f4138
[2021/01/14 0:37:19] Info: InitPlugin: PluginDirectory = E:\ACT\Plugin\Overlay
[2021/01/14 0:37:20] Info: AssemblyResolver: Loaded: CefSharp.OffScreen, Version=75.1.141.0, Culture=neutral, PublicKeyToken=40c4b6fc221f4138
[2021/01/14 0:37:20] Info: AssemblyResolver: Loaded: CefSharp.Core, Version=75.1.141.0, Culture=neutral, PublicKeyToken=40c4b6fc221f4138
[2021/01/14 0:37:20] Info: AssemblyResolver: Loaded: OverlayPlugin.Core.resources, Version=0.16.5.0, Culture=ja-JP, PublicKeyToken=null
[2021/01/14 0:37:20] Info: InitPlugin: Initialised.
[2021/01/14 0:37:33] Info: DFA: GetStructures: URL: https://qitana.github.io/ACT_DFAPlugin/data/structures.json
[2021/01/14 0:37:33] Info: DFA: Started.
[2021/01/14 0:37:33] Info: LoadAddons: DFAPlugin.dll: Initialized Qitana.DFAPlugin.DFAPlugin
[2021/01/14 0:37:34] Info: MopiMopi: BrowserConsole: ACTWS compatibility shim enabled. (Source: , Line: 28)
[2021/01/14 0:37:34] Info: MopiMopi: BrowserConsole: Connecting... (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 280)
[2021/01/14 0:37:35] Info: DFA: Handled: DataSubscription
[2021/01/14 0:37:49] Info: AssemblyResolver: Loaded: OverlayPlugin.Updater.resources, Version=0.16.5.0, Culture=ja-JP, PublicKeyToken=null
[2021/01/14 1:03:53] Info: Found enmity memory for 5.4.
[2021/01/14 1:04:25] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:06:17] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:07:00] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:07:24] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:08:53] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:10:32] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:17:33] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:21:54] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:30:23] Info: DFA: Completed [0/745]
[2021/01/14 1:30:43] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:32:22] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:34:18] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:38:32] Info: DFA: Completed [0/688]
[2021/01/14 1:38:56] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:39:13] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:42:43] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:46:51] Info: DFA: Completed [0/745]
[2021/01/14 1:47:11] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:49:01] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:51:01] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:55:12] Info: DFA: Completed [0/688]
[2021/01/14 1:55:36] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:55:51] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:58:03] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:58:43] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 1:58:55] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:16:45] Info: Found enmity memory for 5.4.
[2021/01/14 11:19:01] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:19:53] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:22:06] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:22:25] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:23:26] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:24:36] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:26:03] Info: DFA: Matched: Tank:0/0 Healer:64/0 DPS:149/43 NonRole:49/16
[2021/01/14 11:32:38] Info: DFA: Matched: Tank:0/0 Healer:64/0 DPS:149/43 NonRole:49/16
[2021/01/14 11:40:20] Info: DFA: ZoneChanged: 179, The Roost
[2021/01/14 11:40:20] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:43:58] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:44:10] Info: DFA: Matched: Tank:0/0 Healer:64/0 DPS:149/43 NonRole:49/16
[2021/01/14 11:45:17] Info: DFA: ZoneChanged: 534, Twin Adder Barracks
[2021/01/14 11:45:17] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:47:39] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:49:21] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:50:39] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)
[2021/01/14 11:58:46] Info: MopiMopi: BrowserConsole: ChangeZone:[object Object] (Source: https://sheeva-r.github.io/mopimopi/js/core.js, Line: 343)