jobs readme (en)

README.md

@@ -33,11 +33,11 @@ cactbot provides these modules:
 
 ![oopsy screenshot](screenshots/promo_oopsy.png)
 
-* jobs: condensed gauges with buff and proc tracking
+* jobs: condensed gauges with resource, cooldowns, buffs, and procs tracking
 
 ![rdm jobs screenshot](screenshots/promo_jobs.png)
 
-* eureka: Eureka NM tracking map
+* eureka: Adventuring Forays (Eureka/Bozja) tracking map
 
 ![eureka screenshot](screenshots/promo_eureka.png)
 
@@ -346,44 +346,51 @@ You can copy oopsy lines to the clipboard by clicking them.
 To use this module,
 point cactbot at **ui/jobs/jobs.html** or use the `Cactbot Jobs` preset.
 
-This module provides health and mana bars, as well as icons and timer bars for big raid buffs such as
-The Balance and Trick Attack. It also features a food buff warning to keep up your food buff when leveling
-or raiding, and a visual pull countdown.
+This module includes 3 part: resource zone at top middle, raidbuff zone at top right, and tracking zone at bottom.
 
-It has more fleshed out support for some jobs but is *strongly* a Work In Progress for others.
+The resource zone shows HP bars and job-specific resource, along with some special counter for some jobs.
+
+The tracking zone shows job-specfic important buff/debuff duration, cooldowns and proc.
+
+The raidbuff zone shows important raidbuffs duration and coming cooldowns.
+
+You can change some of the behavior or appearence via the user panel, e.g. only show the raidbuff zone, or enable compact view.
+
+However, customization of some behavior like cooldown alert thresholds and element order is not availble for now.
 
 <details>
 <summary>Supported Jobs (Click to expand)</summary>
 
-|Job|Feature|
+|Job|Feature (left to right, top to bottom)|
 |:-:|:-:|
-|<img src="./resources/ffxiv/jobs/pld-large.png" width="30px"/><br> Paladin|Shows Oath amount, and atonement stacks, DoT remaining time, Fight or Flight duration/cooldown, Expiacion cooldown and shows combo time remaining.|
-|<img src="./resources/ffxiv/jobs/war-large.png" width="30px"/><br> Warrior|Shows Beast amount, Surging Tempest duration, Upheaval and Inner Release cooldown, and shows combo time remaining.|
-|<img src="./resources/ffxiv/jobs/drk-large.png" width="30px"/><br> Dark Knight|Shows the blood amount and darkside time, BloodWeapon and Delirium and LivingShadow duration/cooldown, and shows combo time remaining.|
-|<img src="./resources/ffxiv/jobs/gnb-large.png" width="30px"/><br> Gunbreaker|Shows No Mercy duration/cooldown, Bloodfest and Gnashing Fang cooldown, Cartridge amount, and shows combo time remaining.|
-|<img src="./resources/ffxiv/jobs/whm-large.png" width="30px"/><br> White Mage|Shows Heal and Blood Lily amount, time to next Lily, DoTs remaining time, and shows Assize and Lucid Dreaming cooldown.|
-|<img src="./resources/ffxiv/jobs/sch-large.png" width="30px"/><br> Scholar|Shows Aetherflow stacks, Fairy gauge amount/time remaining, DoTs remaining time, and shows Aetherflow and Lucid Dreaming cooldown.|
-|<img src="./resources/ffxiv/jobs/ast-large.png" width="30px"/><br> Astrologian|Shows Astrosigns amount, notify who or whether to play the current card, DoTs remaining time, and shows Draw and Lucid Dreaming cooldown.|
-|<img src="./resources/ffxiv/jobs/sge-large.png" width="30px"/><br> Sage|Shows Addersgall and Addersting stacks, time to next Addersgall, DoTs remaining time, and shows Phlegma and Rhizomata and Lucid Dreaming cooldown.|
-|<img src="./resources/ffxiv/jobs/mnk-large.png" width="30px"/><br> Monk|Shows chakra count and form time, and tracks monk buffs and debuffs.|
-|<img src="./resources/ffxiv/jobs/drg-large.png" width="30px"/><br> Dragoon|Shows blood and eye amount, remaining Disembowel time, jump cooldown, and Lance Charge and Dragon Sight duration/cooldown.|
-|<img src="./resources/ffxiv/jobs/nin-large.png" width="30px"/><br> Ninja|Shows Ninki amount, Huton remaining time, Trick Attack duration/cooldown, Bunshin and Mudras cooldown, and shows combo time remaining.|
-|<img src="./resources/ffxiv/jobs/sam-large.png" width="30px"/><br> Samurai|Shows Kenki amount, Meditation stacks, Fugetsu and Fuka and Higanbana duration, Tsubame-gaeshi cooldown, and shows combo time remaining.|
-|<img src="./resources/ffxiv/jobs/rpr-large.png" width="30px"/><br> Reaper|Shows Soul Gauge, Shroud Gauge, Death's Design duration, Soul Slice and Gluttony cooldown, Arcane Circle duration/cooldown, and shows combo time remaining.|
-|<img src="./resources/ffxiv/jobs/brd-large.png" width="30px"/><br> Bard|Shows songs playing and remaining time, Repertoire stack, Soul Voice amount, StraightShotReady track, DoT remaining time, and a bar that show when your DoTs will tick.|
-|<img src="./resources/ffxiv/jobs/mch-large.png" width="30px"/><br> Machinist|Shows Heat gauge, Battery gauge, combo timer, Drill/Bioblaster and Air Anchor and Chain Saw cooldown, Wild Fire cooldown/duration. When Wild Fire is active, there will be a gauge to show how many GCD you have landed.|
-|<img src="./resources/ffxiv/jobs/dnc-large.png" width="30px"/><br> Dancer|Shows combo timer, Feather gauge, Esprit gauge, Standard Step cooldown, Technical Step and Flourish cooldown/duration.|
-|<img src="./resources/ffxiv/jobs/blm-large.png" width="30px"/><br> Black Mage|Shows DoTs remaining time, Firestarter and Thundercloud proc duration, time to next xeno, MP ticker, Fire/Ice stack and umbral heart stack.|
-|<img src="./resources/ffxiv/jobs/smn-large.png" width="30px"/><br> Summoner|Shows Demi-Summoning time, Aetherflow stack, Attunement stacks, Energy Drain cooldown, Trance cooldown, and Lucid Dreaming cooldown.|
-|<img src="./resources/ffxiv/jobs/rdm-large.png" width="30px"/><br> Red Mage|Shows white/black mana, tracks procs for Verstone and Verfire, and Fleche and Contre Sixte cooldown.|
-|<img src="./resources/ffxiv/jobs/blu-large.png" width="30px"/><br> Blue Mage|Shows cooldown of offguard, lucid dreaming, and Song Of Torment DoT remaining time.|
+|<img src="./resources/ffxiv/jobs/pld-large.png" width="30px"/><br> Paladin|Resource zone: Oath Gauge, Sword Oath stack, combo timer, Requiescat stacks (if under Requiescat). Tracking zone: Goring Blade cooldown, Fight or Flight duration&cooldown, Expiacion cooldown.|
+|<img src="./resources/ffxiv/jobs/war-large.png" width="30px"/><br> Warrior|Resource zone: Beast Gauge, combo timer. Tracking zone: Surging Tempest buff duration, Upheaval/Orogeny cooldown, Inner Release cooldown.|
+|<img src="./resources/ffxiv/jobs/drk-large.png" width="30px"/><br> Dark Knight|Resource zone: Blood Gauge, combo timer. Tracking zone: Darkside duration, Blood Weapon cooldown, Delirium cooldown, Living Shadow cooldown.|
+|<img src="./resources/ffxiv/jobs/gnb-large.png" width="30px"/><br> Gunbreaker|Resource zone: Cartridge amount, combo timer. Tracking zone: Gnashing Fang cooldown, No Mercy duration&cooldown, Bloodfest cooldown.|
+|<img src="./resources/ffxiv/jobs/whm-large.png" width="30px"/><br> White Mage|Resource zone: Lily timer, Lily&Blood Lily amount. Tracking zone: Dia/Aero DoT duration, Assize cooldown, Lucid Dreaming cooldown.|
+|<img src="./resources/ffxiv/jobs/sch-large.png" width="30px"/><br> Scholar|Resource zone: Aetherflow stack, Faerie Gauge/Seraph duration. Tracking zone: Bio DoT duration, Aetherflow cooldown, Lucid Dreaming cooldown.|
+|<img src="./resources/ffxiv/jobs/ast-large.png" width="30px"/><br> Astrologian|Resource zone: arcanum helper, held Minor Arcana, held Sign. Tracking zone: Combust DoT duration, Draw cooldown, Minor Arcana cooldown, Lucid Dreaming cooldown.|
+|<img src="./resources/ffxiv/jobs/sge-large.png" width="30px"/><br> Sage|Resource zone: Addersgall timer, Addersgall&Addersting amount. Tracking zone: Eukrasian Dosis DoT duration, Phlegma cooldown, Rhizomata cooldown, Lucid Dreaming cooldown.|
+|<img src="./resources/ffxiv/jobs/mnk-large.png" width="30px"/><br> Monk|Resource zone: chakra stack, form timer, Master's Gauge. Tracking zone: Leaden Fist buff duration, Disciplined Fist buff duration, Demolish DoT duration.|
+|<img src="./resources/ffxiv/jobs/drg-large.png" width="30px"/><br> Dragoon|Resource zone: first brood's gaze stack/Life of the Dragon duration, Firstminds' Focus stack. Tracking zone: Jump cooldown, Power Surge buff duration, Lance Charge duration&cooldown, Dragon Sight duration&cooldown.|
+|<img src="./resources/ffxiv/jobs/nin-large.png" width="30px"/><br> Ninja|Resource zone: Ninki amount, combo timer. Tracking zone: Huton duration, Trick Attack duration&cooldown, Bunshin cooldown, Mudra cooldown.|
+|<img src="./resources/ffxiv/jobs/sam-large.png" width="30px"/><br> Samurai|Resource zone: Kenki amount, Meditation stack, combo timer, held Sen. Tracking zone: Fugetsu buff duration, Fuka buff duration, Tsubame-gaeshi cooldown, Higanbana DoT duration.|
+|<img src="./resources/ffxiv/jobs/rpr-large.png" width="30px"/><br> Reaper|Resource zone: Soul amount, Shroud amount, combo timer, Lemure Shroud/Void Shroud stack (under Enshroud). Tracking zone: Death's Design duration, Soul Slice/Soul Scythe cooldown, Gluttony cooldown, Arcane Circle duration&cooldown.|
+|<img src="./resources/ffxiv/jobs/brd-large.png" width="30px"/><br> Bard|Resource zone: Repertoire stack, Soul Voice amount, Repertoire tick timer, held Coda. Tracking zone: Windbite/Venomous Bite DoT duration, Song duration, Empyreal Arrow cooldown, Straight Shot Ready proc duration.|
+|<img src="./resources/ffxiv/jobs/mch-large.png" width="30px"/><br> Machinist|Resource zone: Heat/Overheated stack, Battery/Automaton Queen duration, combo timer, Wildfire GCD counter (if Wildfire active). Tracking zone: Drill/Bioblaster cooldown, Air Anchor cooldown, Chain Saw cooldown, Wildfire duration&cooldown.|
+|<img src="./resources/ffxiv/jobs/dnc-large.png" width="30px"/><br> Dancer|Resource zone: Fourfold Feather amount, Esprit amount, combo timer. Tracking zone: Standard Step cooldown, Technical Step duration&cooldown, Flourish duration&cooldown.|
+|<img src="./resources/ffxiv/jobs/blm-large.png" width="30px"/><br> Black Mage|Resource zone: Umbral Ice/Astral Fire duration, Polyglot timer, MP tick timer, Umbral Hearts stack&Polyglot stack. Tracking zone: Firestarter proc duration, Thunder DoT duration, Thundercloud proc duration.|
+|<img src="./resources/ffxiv/jobs/smn-large.png" width="30px"/><br> Summoner|Resource zone: Trance/Attunement duration, Aetherflow stack, Arcanum held and Attunement stored in. Tracking zone: Energy Drain/Energy Siphon cooldown, Summon Bahamut/Phoenix cooldown, Lucid Dreaming cooldown.|
+|<img src="./resources/ffxiv/jobs/rdm-large.png" width="30px"/><br> Red Mage|Resource zone: White Mana and Black Mana amount, Mana Stack (if any). Tracking zone: Verstone Ready duration, Verfire Ready duration, Fleche cooldown, Contre Sixte cooldown.|
+|<img src="./resources/ffxiv/jobs/blu-large.png" width="30px"/><br> Blue Mage|Resource zone: none. Tracking zone: Off-guard/Peculiar Light cooldown, Song of Torment/Nightbloom/Aetherial Spark DoT duration, Lucid Dreaming cooldown.|
 
 </details>
 
-In this screenshot, the jobs module is highlighted for the Red Mage job. The health and mana bars, as well
-as Red Mage white/black mana tracking is circled in purple, with the large raid buff tracking pointed to
-beside it in orange. <del>The first step of the melee combo has been executed, which is displayed as the yellow
-box above the health bar.</del> The proc tracking is circled below in green.
+In this screenshot, RDM jobs UI is shown as example.
+The ingame UI is shown at top and jobs module is shown at bottom.
+HP&MP bar, White Mana and Black Mana are shown in purple.
+The right yellow is raidbuff icon.
+Verstone Ready duration, Verfire Ready duration, Fleche cooldown, Contre Sixte cooldown are shown in red.
 
 ![jobs screenshot](screenshots/Jobs.png)
 

docs/zh-CN/README.md

@@ -104,9 +104,10 @@ cactbot提供以下模块：
 ### 插件加载顺序
 
 由于cactbot的依赖关系，它需要在FFXIV解析插件和OverlayPlugin之后加载。 正确的顺序应该是：
-- FFXIV解析插件
-- OverlayPlugin，
-- cactbot
+
+* FFXIV解析插件
+* OverlayPlugin，
+* cactbot
 
 ![插件顺序](../../screenshots/get_plugins_complete.png)
 
@@ -282,7 +283,9 @@ ThirdParty
 
 团辅区显示重要团辅的持续时间和即将冷却完毕的团辅冷却时间。
 
-通过用户面板设置可以更改部分外观和行为，例如只显示团辅区，以及缩小资源区和监控区之间的空隙等，但许多运行逻辑暂不支持调整。
+通过用户面板设置可以更改部分外观和行为，例如只显示团辅区，以及缩小资源区和监控区之间的空隙等。
+
+但jobs模块的可自定义程度比较低，如冷却提示阈值、各界面元素顺序等暂不支持调整。
 
 <details>
 <summary>支持的职业 (点击展开)</summary>
@@ -294,7 +297,7 @@ ThirdParty
 |<img src="../../resources/ffxiv/jobs/drk-large.png" width="30px" /><br> 暗黑骑士|资源区：暗血值、连击计时器。监控区：暗黑持续时间、嗜血冷却时间、血乱冷却时间、掠影示现冷却时间。|
 |<img src="../../resources/ffxiv/jobs/gnb-large.png" width="30px" /><br> 绝枪战士|资源区：晶壤数量、连击计时器。监控区：烈牙冷却时间、无情持续时间和冷却时间、血壤冷却时间。|
 |<img src="../../resources/ffxiv/jobs/whm-large.png" width="30px" /><br> 白魔法师|资源区：治疗百合获得计时器、治疗百合和血百合的数量。监控区：天辉DoT持续时间、法令冷却时间、醒梦冷却时间。|
-|<img src="../../resources/ffxiv/jobs/sch-large.png" width="30px" /><br> 学者|资源区：以太超流档数、异想以太量和炽天使持续时间。监控区：蛊毒法DoT持续时间、以太超流冷却、醒梦冷却。|
+|<img src="../../resources/ffxiv/jobs/sch-large.png" width="30px" /><br> 学者|资源区：以太超流档数、异想以太量和炽天使持续时间。监控区：蛊毒法DoT持续时间、以太超流冷却时间、醒梦冷却时间。|
 |<img src="../../resources/ffxiv/jobs/ast-large.png" width="30px" /><br> 占星术士|资源区：奥秘卡提示器、持有的小奥秘卡、持有的印记。监控区：焚灼DoT持续时间、抽卡冷却时间、小奥秘卡冷却时间、醒梦冷却时间。|
 |<img src="../../resources/ffxiv/jobs/sge-large.png" width="30px"/><br> 贤者|资源区：蛇胆获得计时器、蛇胆和蛇刺的数量。监控区：均衡注药DoT持续时间、发炎冷却时间、根素冷却时间、醒梦冷却时间。|
 |<img src="../../resources/ffxiv/jobs/mnk-large.png" width="30px" /><br> 武僧|资源区：斗气档数、身形计时器、必杀技量谱。监控区：连击效果提高buff持续时间、功力buff持续时间、破碎拳DoT持续时间。|
@@ -304,9 +307,9 @@ ThirdParty
 |<img src="../../resources/ffxiv/jobs/rpr-large.png" width="30px"/><br> 钐镰客|资源区：灵魂量值、魂衣量值、连击计时器、夜游魂和虚无魂档数（处于附体状态时）。监控区：死亡烙印持续时间、灵魂切割和灵魂钐割冷却时间、暴食冷却时间、神秘环持续时间和冷却时间。|
 |<img src="../../resources/ffxiv/jobs/brd-large.png" width="30px" /><br> 吟游诗人|资源区：诗心档数、灵魂之声量、诗心获得计时器、持有的尾声。监控区：风蚀箭和毒咬箭DoT持续时间、当前战歌持续时间、九天连箭冷却时间、直线射击预备触发持续时间。|
 |<img src="../../resources/ffxiv/jobs/mch-large.png" width="30px" /><br> 机工士|资源区：枪管热度量或过热档数、电能量或后式自走人偶持续时间、连击计时器、野火GCD计数器（发动野火时）。监控区：钻头和毒菌冲击冷却时间、空气锚冷却时间、回转飞锯冷却时间、野火持续时间与冷却时间。|
-|<img src="../../resources/ffxiv/jobs/dnc-large.png" width="30px" /><br> 舞者|资源区：幻扇数、伶俐量、连击计时器。监控区：标准舞步冷却、技巧舞步持续时间与冷却时间、百花争艳持续时间与冷却时间。|
+|<img src="../../resources/ffxiv/jobs/dnc-large.png" width="30px" /><br> 舞者|资源区：幻扇数、伶俐量、连击计时器。监控区：标准舞步冷却时间、技巧舞步持续时间与冷却时间、百花争艳持续时间与冷却时间。|
 |<img src="../../resources/ffxiv/jobs/blm-large.png" width="30px" /><br> 黑魔法师|资源区：灵极冰与星极火持续时间、通晓获得计时器、魔力恢复计时器、灵极心档数和通晓档数。监控区：火苗触发持续时间、雷系DoT持续时间、雷云触发持续时间。|
-|<img src="../../resources/ffxiv/jobs/smn-large.png" width="30px" /><br> 召唤师|资源区：亚灵神召唤或属性以太持续时间、以太超流档数、持有的宝石奥秘和属性以太。监控区：能量吸收冷却时间、龙神召唤或不死鸟召唤冷却时间、醒梦冷却时间。|
+|<img src="../../resources/ffxiv/jobs/smn-large.png" width="30px" /><br> 召唤师|资源区：附体或属性以太持续时间、以太超流档数、持有的宝石奥秘和保存在其中的属性以太。监控区：能量吸收和能量抽取冷却时间、龙神召唤或不死鸟召唤冷却时间、醒梦冷却时间。|
 |<img src="../../resources/ffxiv/jobs/rdm-large.png" width="30px" /><br> 赤魔法师|资源区：白魔元与黑魔元量、魔元集档数（如果有）。监控区：赤飞石预备持续时间、赤火炎预备持续时间、飞刺冷却时间、六分反击冷却时间。|
 |<img src="../../resources/ffxiv/jobs/blu-large.png" width="30px" /><br> 青魔法师|资源区：无。监控区：破防和惊奇光冷却时间、苦闷之歌或月下彼岸花或以太火花DoT持续时间、醒梦冷却时间。|