~~META:
creator       = StarHawk
&description abstract = On screen display experience points related information.
~~
~~NOCACHE~~


====== ExpWatch (2.0) ======



<note warning>This is plugin is in Beta 1. You MAY experience crashes. Please report issues on the forums or IRC.</note>



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

^   Information  ^^
^   Developer:| [[:user/StarHawk | StarHawk]] |
^   Download:| [[http://www.windower.net/plugins/ExpWatch.dll | ExpWatch]] |
^   Download Count:| [dlcount]expwatch[/dlcount] |
^   Support:| [[http://www.windower.net/forums/viewforum.php?f=22 | Click Here]] |
^   Release Date:| July 4th 2008 |
^   Changelog:| [[#change_log | Click Here]] |
^   Known Issues:| [[#known_issues | Click Here]] |
^   Planned Features:| [[#planned_features | Click Here]] |
^   Support/Development Log:| [[http://forums.windower.net/index.php?showtopic=12817 | Click Here]] |

<note important>This plugin is still being developed, so please check back often, and expect some features listed here to not work, and new features to be implemented!</note>


===== What is ExpWatch =====

<term TNL>"To Next Level" - Amount of experience points required to level.</term>
<term TNM>"To Next Merit" - Amount of limit points required to merit.</term>
<term TTL>"Time To Level" - Amount of time required to reach your next level.</term>
Shows information, on the screen, regarding your experience, limit, and merit points; such as your TNL, TTL, TNM, and Chain info.


<note>While setting the displayed information, you may not be able to type the entire line into the the chat area. A workaround to this is to create a .txt file in your scripts folder, and make changes to the EXPWatch display there. Then, to make changes, all you do is execute the file.</note>


===== Usage =====

<note information>Expwatch is now autoload friendly!</note>

[[ExpWatch]] can be loaded by opening your Windower console and typing //load expwatch//. Nothing further is required to make use of this plugin. [[ExpWatch]] **is** autoload friendly.

[[ExpWatch]] supports the following commands. Usage of these commands is not necessary.

=== Commands ===
**PLEASE NOTE: All commands and their values are lowercase!**

  ?statusbar
  ?statusbar75
  ::Shows/sets the format string for your non-75 job, and 75 job bar, respectively. Using the command with no text will show your current bar settings. Whatever text you type in after the command will be used in the display of your bar. There are special "keywords" that trigger the various pieces of information expwatch can display. Please see the [[#keywords]] section below for more information.
  ?locale
  ::Enables/Disables locale support. This adds/removes the commas in the numeric values, or whatever your locale uses (non-US English locales don't always use commas to seperate digits). Just typing the command will toggle the current state. Adding a value of "1", "true", or "on" will enable it. Any other value will disable it.
Example output:
<code>
20,168/44,000(23,832)  4,542/10,000(5,458)[0]  0.0k/hr  CH 0(0:0)  EXP 10(10+0)-0.0
</code>
This translates into
<code>
{exp_level_current}/{exp_level_max}({exp_next_level})  {limits_current}/{limits_max}({limits_next_merit})[{merits_current}]  {exp_hour_k}k/hr  CH {chain_count}({chain_remaining_seconds}:{chain_elapsed_seconds})  EXP {exp_kill_last}({chain_exp_base}+{chain_exp_bonus})-{exp_kill_average}
</code>

=== Chat Support ===
ExpWatch works with your chat!  If you type one of the [[#keywords]] into the chat box, it will send the results! You can now do things like ///p My TNL is {exp_next_level_k}k.// it would send ///p My TNL is 23.2k//








===== Keywords =====
**PLEASE NOTE: All keywords are lowercase!**

**PLEASE NOTE: This is the //__CURRENT__// list of keywords. Many more commands are keywords.**
  ?{exp_sec}
  :Average experience points gained per second
  ?{exp_hour}
  ?{exp_hour_k}((The "k" version returns in abbreviated thousandths, to the first decimal place.))
  :Average experience points gained per hour.
  ?{exp_level_current}
  ?{exp_level_current_k}((The "k" version returns in abbreviated thousandths, to the first decimal place.))
  :Your experience points, on your current level.
  ?{exp_level_max}
  ?{exp_level_max_k}((The "k" version returns in abbreviated thousandths, to the first decimal place.))
  :The amount of experience points required to reach 100% for the next level.
  ?{exp_next_level}
  ?{exp_next_level_k}((The "k" version returns in abbreviated thousandths, to the first decimal place.))
  :The amount of experience points remaining to reach the next level.
  ?{exp_kill_last}
  :Amount of experience points of your last kill.
  ?{exp_kill_average}
  :Average amount of experience points per kill.
  ?{limits_current}
  ?{limits_current_k}((The "k" version returns in abbreviated thousandths, to the first decimal place.))
  :Your current limit points.
  ?{limits_max}
  ?{limits_max_k}((The "k" version returns in abbreviated thousandths, to the first decimal place.))
  :The amount of experience points required to reach 100% for the next merit. Currently this is a "constant" 10,000 limit points.
  ?{limits_next_merit}
  ?{limits_next_merit_k}((The "k" version returns in abbreviated thousandths, to the first decimal place.))
  :Amount of limit points required to reach your next merit.
  ?{merits_current}
  :Your current merit points
  ?{chain_count}
  :Your current chain number
  ?{chain_remaining_seconds}
  :The number of seconds remaining, until your experience/limit chain is broken
<note warning>Several people have reported these chain timers as being wrong. Please see [[ffxic>Experience_Chain]], and help them get the information updated and corrected, as this is where I acquired the chain timer information.</note>
  ?{chain_elapsed_seconds}
  :The number of seconds that have elapsed in your current experience/limit chain
  ?{chain_exp_base}((For more information  on experience chains, see [[ffxic>Experience_Chain]]))
  :The base experience you acquired for killing the monster, before applying the chain bonus
  ?{chain_exp_bonus}((For more information  on experience chains, see [[ffxic>Experience_Chain]]))
  :The bonus experience points you have acquired for being in a chain
  ?{chain_bonus}((For more information  on experience chains, see [[ffxic>Experience_Chain]]))
  :The percentage of experience gained for the current chain



===== Change Log =====
  * July 4 2008 - Version 2.0 Released - Complete code rewrite.







===== Known Issues =====
  * Your 1st and 2nd kill may show some wild experience per hour
  * Your last kill experience never resets, even though your experience per hour and other data does, which is technically correct, but it should reset after a timeout period has passed
  * Data does not reset when you change jobs
  * **OCCASIONALLY** on gaining experience points, the whole game will hard-lock (this should be fixed, but needs testing)
  * The results from ''statusbar'' and ''statusbar75'' go off the edge of the screen, which makes seeing the entire line impossible
  * Does not currently track experience gained out of actual exp parties, such as campaign, besieged, exp scrolls
  * There is a conflict with versions of **Spellcast**  older than 2.18, causing the chat {} commands to not work. A workaround is to change the order in which you load the plugins. This is a bug in **Spellcast** 2.17 and older... It is NOT an Expwatch bug.




===== Planned Features =====
  * Add shorter keywords, as well as some grouped keywords. ex. {tnm} would be synonomous to {limits_next_merit}, or {exp} could be {exp_level_current}/{exp_level_max}
  * Add more keywords such as current job/subjob and levels, time to level/merit
  * Add reset command to reset your current running totals
  * Add a "summary" command that when used would dump (to chat) your current statistics since last reset command
  * Add "current mode" shortcuts to some commands. ex. {tnc} would either equal {tnm} or {tnl} depending on if you were on limit or experient point mode