Smeagol 1.3.0
automatically uses XP rings (if under lv99) or CP rings (if at lvl99).
Download:
https://github.com/lili-ffxi/FFXI-Addons/
Supports the following items:
XP: Sprout Beret, Echad Ring, Caliber Ring, Emperor Band, Empress Band, Resolution Ring, Kupofried's Ring, Allied Ring
CP: Guide Beret, Trizek Ring, Endorsement Ring, Facility Ring, Capacity Ring, Vocation Ring
Smeagol will use XP rings if your level is less than 99, and CP rings if you're at level 99. This can be overridden (for example to farm merits, or for gain exp, etc).
Smeagol will only look for rings in your main Inventory, and in Wardrobes 1-8. If you want to hide a ring from him (want to keep that Novennial ring for some reason?), put it in any other bag.
IMPORTANT: as of version 1.0.0, Smeagol will no longer attempt to use CP rings at level 98 and below.
Features:
- override mode
- works with Kupofried
- plays nice with gearswap (disables the slot before using the ring, and reenables it after)
- will only activate while Idle or Engaged, and not inside Mog House.
- will not use rings while in town. This can be overriden with a command.
- will not use rings while moving.
- will not use rings while you have capped JP
- will not use rings while you have caped Merits, unless you also have the Emporox's Gift buff active.
Commands:
//smeagol on|start|off|stop - starts or stops Smeagol. Smeagol is automatically active when started.
//smeagol xp|both|normal - Changes how Smeagol chooses the ring to use at level 99. See below.
//smeagol <number> - how often Smeagol should check if an exp buff is active, in seconds. Default is 4.
//smeagol check - wake up from sleep and immediately check if a ring is available
//smeagol town - toggles use of rings in town. Default is no.
//smeagol reset - restores default settings.
//smeagol r|reload|u|unload - reloads/unloads Smeagol.
How does the override work:
- DEFAULT: The default mode is `normal`. This will use CP rings at level 99, and XP rings at level 98 or lower.
- XP: When override is set to `xp`, Smeagol will only use XP rings no matter what the level of the character. Useful for merit/potpourri farming.
- BOTH: When override is set to `both`, Smeagol will use both types of rings at level 99 - first CP rings, then when those are all on cooldown, XP rings. CP rings are still only used at level 99.
Changelog:
- 1.3.0 - Added support for wardrobes 5-8.
- .....
- 1.2.3 - Added idle_ring fallback for characters without gearswap.
- 1.2.2 - Improved midaction logic, added a distance check for Kupofried.
- 1.2.1 - Fixed a but in the capped merit detection logic.
- 1.2.0 - Tentatively added midaction detection. Smeagol will now not attempt to use a ring while you're casting a spell or using an ability.
- 1.1.0 - Human readable times, added detection for capped JP/Merits, added movement check.
- 1.0.1 - Minor code tweak.
- 1.0.0 - Breaking changes to the override logic. Added town check and related command.
- 0.5.0 - Reduced memory usage, and fixed a bug where a CP bonus buff would be overwritten with an XP buff (and vice versa) under certain circumstances. Thanks to Meeble for the bug report.
- 0.4.0 - Added new CP ring (April 2019 update), added check for logged in status.
- 0.3.0 - Reduced memory usage, removed race condition, added
check command.
- 0.2.0 - Added checks for Mog House and Idle/Engaged status.
- 0.1.2 - Removed chatlog spam that occurred when all available rings were on recast, and other adjustments
- 0.1.0 - Initial release.
To-do:
- fix the re-equip function. Low priority because gearswap is a thing.
Known issue:
- If multiple copies of the same ring are found, Smeagol will only consider one of them when checking for recast, and ignore all other copies. I consider this a minor bug since there is only one ring without the Rare tag (Resolution ring), so the fix for this will have to wait for when I have more time. Thanks to Oheyo from the Windower discord for finding this bug.
- If Kupofried is summoned while Smeagol is on and a buff is already active, a ring might be used in the few seconds that pass between Kupofried appearing in party, and his aura becoming active on the player. This is because the aura takes a few seconds to activate - it activates on a server tick and not when the spell is finished casting, like all geomancy auras. I have a possible fix in mind but it will take a while, for now just be mindful of your moogles.
Smeagol does not
yet save settings across sessions.
To change the default delay, edit the 'cycle_time' variable at line 55 of the lua.
To make Smeagol use rings even in town by default, change 'use_in_town' from 'no' to 'yes' at line 56 of the lua.
To remove rings/items, edit line 45 and 46 (xp_rings and cp_rings). Do not edit anything else! Items are used in the order they are listed, so if, for example, you want to use your Resolution Ring before reusing your Caliber Ring, just move it a bit to the left in the list. The list is case sensitive, and be sure to respect the comma.
For characters without gearswap, it's possible to specify a ring to go back to after using XP/CP rings. Just put the ring name in the idle_ring variable on line 50 of the lua.
Smeagol only cares about rings! (and Sprout/Guide Berets). It does not care about CP mantles or anything else. He's not very smart, but he does his best.
Again,
Smeagol only looks into your main Inventory and in your Wardrobes when looking for rings. If he's not using rings, they're probably somewhere else.
Thanks a lot to Selindrile and from20020516, half of Smeagol's code is from their stuff.
Bug reports or suggestions are welcome.
NOTE: I get that it would be somewhat convenient, but Smeagol will never ever automatically toss a ring that ran out of charges. Stop asking. It's his preciousss, why would he ever toss one?
Enjoy,
Lili.