~~META:
creator       = Ragns
&description abstract = Displays on screen duration timers until spells or abilities wear off.
~~
~~NOCACHE~~
====== YarnBall (3.02) ======

===== Plugin Information =====

^   Information  ^^
^   Developer:| [[:user/Ragns|Ragns]] |
^   Download:| [[http://windower.net/plugins/YarnBall.dll | YarnBall]]|
^   Download Count:| [dlcount]yarnball[/dlcount] |
^   Release Date:| April 6th, 2008 |
^   Changelog:| [[:plugins:yarnball/changelog | Click Here]]|

===== What is YarnBall =====

[[YarnBall]] is a plugin that displays duration timers of spells and abilities you use, letting you know when they will wear off.


===== Usage =====

[[YarnBall]] can be loaded by opening your Windower console and typing //load yarnball//. [[YarnBall]] works best when it is loaded automatically, so one should add the //load yarnball// command to the **init.txt** file in the **scripts** folder where Windower resides. 

[[YarnBall]] does not require the chat filters to be turned off. You may filter the chat as you please and [[YarnBall]] will continue to work.


===== Configuration =====

==== Timers Location ====

The position of the display can be changed using the //Pos X Y// command. **X** and **Y** are the values to the number of pixels from the top left corner of the ffxi window. 
<code>
  .yarnball Pos 20 300
</code>

==== Font Size ====

The font size can be changed using the //FontSize size// command. Set the **size** value to the size of the font.
<code>
  .yarnball FontSize 10
</code>

==== Font Bold ====

The font weight can be changed using the //FontBold value// command. Set the **value** to 0 or 1 to disable or enable the bold effect on the displayed text.
<code>
  .yarnball FontBold 1
</code>

==== Double Food ====

By default [[YarnBall]] assumes that the player doesn't have the **Increased meal duration** bonus. To override this one can use the //DoubleFood value// command. Set the **value** to 0 or 1 to disable or enable the **Increased meal duration** bonus.
<code>
  .yarnball DoubleFood 1
</code>

==== Winning Streak ====

By default [[YarnBall]] assumes that the player doesn't have any Winning Streak merits. To override this one can use the //WinningStreak value// command. Set the **value** to 0, 1, 2, 3 to see the extra time bonus on rolls.
<code>
  .yarnball WinningStreak 3
</code>

==== Bar Elemental ====

By default [[YarnBall]] assumes that the barelemental spells duration is 2:30 (which fits with most job75/whm37). Because the calculation for barelemental spells duration isn't known yet, one may use the //BarElement time// command to use his own values. Set the **time** to the number of seconds the effect last.
<code>
  // duration for most whm75
  .yarnball BarElement 190
</code>

==== Dancer AF ====

By default [[YarnBall]] assumes that the player uses the Dancer AF which gives a duration bonus on sambas. To override this one can use the //DncAF value// command. Set the **value** to 0 or 1 to disable or enable the time bonus.
<code>
  .yarnball DncAF 1
</code>

==== Bard Instruments ====

By default [[YarnBall]] assumes that the player uses all the +2 instruments except for Mazurka and Ballad. To override this one can use the //song value// command. Set the **value** to 0, 1, 2 or 3 if you use the NQ, +1, +2 or +3 instruments.
<code>
  .yarnball Paeon 2
  .yarnball Ballad 0
  .yarnball Minne 2
  .yarnball Minuet 2
  .yarnball Madrigal 2
  .yarnball Aubade 2
  .yarnball Pastoral 2
  .yarnball Hum 2
  .yarnball Fantasia 2
  .yarnball Operetta 2
  .yarnball Capriccio 2
  .yarnball Round 2
  .yarnball Serenade 2
  .yarnball Gavotte 2
  .yarnball Rhapsody 2
  .yarnball Aria 2
  .yarnball March 2
  .yarnball Carol 2
  .yarnball Hymnus 2
  .yarnball Mazurka 0
  .yarnball Prelude 2
  .yarnball Sirvente 2
  .yarnball Dirge 2
  .yarnball Etude 2
</code>

==== Sample init.txt ====
<code>
  load yarnball
  .yarnball Pos 20 400
  .yarnball FontSize 14
  .yarnball DncAF 0
  .yarnball Ballad 2
  .yarnball Mazurka 2
</code>


===== Monitored Actions =====

  * Haste and Refueling
  * Protect
  * Shell
  * Regen
  * Refresh
  * Barelemental (Barfire, Barblizzard, Baraero, Barstone, Barthunder, Barwater)
  * Barstatus (Barsleep, Barpoison, Barparalyze, Barblind, Barsilence, Barpetrify, Barvirus)
  * Reraise
  * Bard song buffs
  * Food
  * Dancer's samba
  * Corsair's roll
  * Samurai's Hasso and Seigan


===== Known Issues =====

  * Problems with oversized background (should be fixed with Windower 3.4).