TOB: Refinements
A Spellhold Studios mod
Authors: T.G.Maestro, Littiz and the bigg | Forum (opens new window) | Mod homepage (opens new window) | Version: 4.27
Introduction | Compatibility notes | Installation | Components | FAQ | Version history | Credits | Contact info

#### Introduction

The Refinements Mod is somewhat of an arrogant project.
We feel that many things in the game are somehow misplaced, not detailed enough, not balanced enough, not cool enough, or... you get the picture.
So we've tried to fix them, with the aim to provide a fitting new standard form for the game.
We don't know how many people will agree with this presumption, but we'll act as if they are many.
This project started with one us (Littiz) offering to WeiDU-code some material the other author (T.G.Maestro) was producing for personal use (new HLAs and tables for various classes, to be exact).
Some things don't deserve to be wasted :)
We have focused on different things, but "kept an eye" on each other, shared ideas, corrected things and much more.
Now we feel this mod is our "common property"!
It's still an evolving work; you never know how many things you may want to refine, given time :D
We provide separate, detailed documentation for each installable component, so some advice for the lazy player:

CHECK THE DOCS! They ARE part of the mod!!!

We try to provide as much in-game documentation as possible, but these docs will always be more detailed.

This version of Refinements has been updated by Subtledoctor. I tried to make the HLAs modular, so that you can install HLAs for one class but not for another. This way you can mix 'n' match Refinements with different mods like Rogue Rebalancing, Faiths & Powers, etc. These HLA components have been tested and install correctly on BG2EE v1.3... but I have not done much playtesting yet. Consider this EE compatibility to be a beta. For the moment, the multiclass HLAs do not install... I think I have a way to make them work with this new modular design, but it will take some time to do.

Please note that the HLA component(s) are the ONLY components I have updated.

#### Compatibility notes

Some components of this mod are meant to be used along with other mods (we strongly suggest to use aVENGER's Rogue Rebalancing Mod, and Sim's Virtue Mod).
ToBEx is strongly recommended as well: 'Allow 1280 Total Kits' is required if you installed a lot of kit mods, 'Kit() Trigger Fix' is required if you installed a mod to enable Barbarian -> Mage, Barbarian -> Thief or Wild Mage -> Thief dual classes, and the following are recommended in any case: 'Apply Casting Level Bonus' and 'Assassin and Bounty Hunter Penalty to Similar Kits'.
Furthermore, some components raise issues with the order of installation.
We detail case by case what you need to know, but here's our...

"Simplified" ordering rule:
Install Refinements AFTER other mods, but BEFORE starting a new game.
These mods make an exception and should be installed AFTER Refinements:

- The Bigg's Tweak Pack
- Kivan of Shilmista

This is the quickest way to deal with all the aforementioned issues. It will work fine, but you might lose some alternatives granted by other mods. If you want full control over the installation, read our docs and choose how to proceed ;)

Also note that item mods need to receive manual handling on our part, so they aren't compatible unless explicitly listed.

The currently compatible item mods are:

- Rogue Rebalancing
- Item Upgrade
- Ruad
- Freedom's Reign
- Reign of Virtue

If your favorite mod isn't listed here, please contact us and we'll try to rectify for the next release. (note: we won't make the needed work for TDD / BP kits; we might do it for the items, though.)

#### Installation

##### Windows

Refinements is packaged and installed with WeiDU and is distributed as a self-extracting archive. To install, simply double-click the archive and follow the instructions on screen.
Alternatively the files can be extracted from the archive using WinRAR. If properly extracted, you should have a Refinements folder, setup-Refinements.tp2 and Setup-Refinements.exe in your BG2 folder. To install, simply double-click Setup-Refinements.exe and follow the instructions on screen.
Please re-run Setup-Refinements.exe in your BG2 folder to reinstall, uninstall or otherwise change components.

##### Macintosh

If the mod was previously installed, uninstall it before extracting the new version. Please note that this mod is incompatible with Mod Organizer. Refinements is packaged and installed with WeiDU. To install, simply extract the contents of the mod into your BG2 folder. If properly extracted, you should have a Refinements folder, setup-Refimenents.tp2, Setup-Refinements, and Setup-Refinements.command in your BG2 folder. To install, simply double-click Setup-Refinements.command and follow the instructions on screen.

##### Linux

Download the latest version of WeiDU for Linux from weidu.org and extract (at least) the WeiDU, weinstall and tolower executables in a $PATH directory (E.G. /usr/bin).
Following that, open a terminal, cd to your BG2 installation directory, run `tolower' and answer Y to both queries.
You can avoid running the second option (linux.ini) if you've already ran it once in the same directory. To save time, the archive is already tolowered, so there's no need to run the first option (lowercasing file names) either if you've extracted only this mod since the last time you lower cased file name.
If you're unsure, running tolower and choosing both options is the safe bet.
After that, run 'weinstall refinements' from your BG2 installation directory to install or uninstall the mod.

#### Components

List of currently available components (each component will link to a more complete description):

- New HLAs Tables for all classes *,**
- "SwashImoen"
- Shapeshifting Fix
- Universal lesser mage robes
- Sword Angel Kit *
- Revised Armor and Shields **

* this component includes a complete fix for the 5th level spell "Spell Shield". Don't ask. Technical reasons.
** this component will cap the phisical damage resistance (slashing, piercing, crushing and missile) to 75% for all classes, except Barbarians, whose cap is 85%.

##### New HLAs Tables for all classes

Entirely re-designed and re-built HLAs tables for all classes and kits in the game to provide distinctive class specific HLAs.
The following items will be slightly modified for reasons of balance and coherency: Cloack of Vecna (will give only -2 to spellcasting speed to Sorcerors, while still giving a full -4 to other classes), and the cloack of Montolio (which now gives +1 thac0 to primary and secondary hand, rather than +2 to secondary).
See: Complete Description (will launch a new page).
This component is incompatible with the Archer of Sylvanus kit from Sorcerer's Place and/or SPStuff.

##### "SwashImoen"

Turns Imoen in a Swashbuckler/Mage and makes other changes.
Used to Require the Revised High Level Abilities component, the first install choice (for technical reasons), but this has been solved.
See: Complete Description (will launch a new page).

##### Shapeshifting fix

Complete fixes for all druids' shapeshifting forms.
See: Complete Description (will launch a new page).

##### Universal Lesser Mage Robes

Complete fixes for all druids' shapeshifting forms.
This component alters the lesser mage robes to be useable by monks too.
The complete list of robes affected is the following:

- Robe of Cold Resistance
- Robe of Fire Resistance
- Robe of Electrical Resistance
- Knave's Robe
- Traveler's Robe
- Adventurer's Robe

##### Sword Angel Kit

A noble fighter, with a focus on "spiritual" abilities and HLAs.
If you want to play an extremely good character, and try a new challenge...
*Not* for powergamers!!!
The S.A. Kit can (and SHOULD!!!) be used in combination with Sim's VIRTUE mod!
See also the Compatibility notes for mod ordering issues!
See: Complete Description (will launch a new page).

##### Revised Armors and Shields

This component revises all armors and shields in game, adding new elements (both to the roleplaying and to the tactical level) to be considered when choosing your equipment.
See: Complete Description (will launch a new page).

#### Frequently Asked Questions

Q: I've found a bug / incompatibility / have a suggestion!
A: Contact us and we'll deal with it as soon as possible.

Q: Are there any more questions?
A: Well, so far it seems our docs are detailed enough :D

Q: But I do have a question!
A: Contact us and we'll add it here.

#### Version History

17 December 2016 - Version 4.0 beta9: updated by Isaya

- French translation update.
- Use of HANDLE_CHARSETS to add BG2EE compatibility for languages other than English.
- Update dependent software: WeiDU v 240.

26 August 2016 - Version 4.0 beta8: authored by subtledoctor

- Update for BG2EE. Read this discussion for details.
- Install HLAs on a class-by-class basis.
- Patches HLA tables instead of overwriting them.
- Patches HLA tables of mod kits in addition to base kits.
- specific compatibility with RR HLAs and simplified install order (RR, then Refinements).
- The Sword Angel works in EE games.
- Update dependent software: WeiDU v 239.

3 January 2012 - Version 3.31:

- Assassin's Nerve Poison actually holds creatures now.
- A bunch of permanent HLAs carry over their bonuses if you resurrect your character. Please report if you find any other needing such a fix.
- Poisons crafted via Assassin's Brew Poision are useable without taking Use Scrolls first.
- The Raging Mind Poison crafted via Assassin's Brew Poision doesn't crash the game.
- Update dependent software: WeiDU v 231, ToBEx v 22.

12 February 2011 - Version 3.30:

- Integration with ToBEx: Barbarian -> Mage, Barbarian -> Thief, Wild Mage -> Thief compatibility, Bounty Hunters and Assassins can get Use Scrolls.
- Distribute ToBEx.
- Fixed Tireless Rage not providing +4 to STR and COS as per description.

3 January 2011 - Version 3.25:

- Fixed a scripting typo that was causing compatibility problems.

13 November 2010 - Version 3.24:

- Tweak to the system that prevents multiclass mages from casting either Mirrored Clones or Death Field, for better compatibility with some mods.
- Advertise Ascension64's TobEx (Apply Casting Level Bonus fixes Union, Allow 1280 Total Kits prevents crashes if there are too many kits).
- Compatibility with Human multiclasses, Fighter/Illusionist/Thieves and Fighter/Illusionist/Clerics from TobEx.
- Blades and Diviners now get HLAs (OS-related regression?).
- Use ADD_SECTYPE to avoid possible conflicts.

2 June 2010 - Version 3.23:

- Russian translation.

27 April 2010 - Version 3.22:

- Barbarians are forbidden from dual-classing to thief and/or mage. Otherwise, both Barbarians and Wild Mages would get very glitchy.
- Don't alter the Robe of Vecna and Montolio's Clasp if Item_Rev is installed.
- Patch minor robe's description, rather than overwrite.
- Don't alter Shield +1/+4's description if IR is installed.
- Make sure nobody dies from dexterity reduction from armor.
- Don't install the armor & shield revision component if item_rev is installed.

?? - Version 3.21:

- Fixed a typo in the jester's HLA table. Thanks: aVENGER.

?? - Version 3.20:

- Compatible with CtB - Tracking is patched rather than overwritten. TBT.
- Fixed some minor typoes in the AIs for two elementals.
- Endurance HLA doesn't stack or stacks or something with Boots of Speed.
- Sword Angel, should be compatible with pretty much all mod items under the sun (where compatible = not wearable by a SA if it's a vile item). TBT
- Removed the stutter-causing Damage Resistance Cap. Feel free to get 127% slashing damage, you dirty cheater :)
- Armor Revision is now compatible with many more item mods, also thanks to code made by Caedwyr and CamDawg. Needs testing, and item descriptions might be suboptimal.
- Thanks to Acheron for pointing out that some scroll-related code was causing some compatibility issues (and giving the code to fix this).

?? - Version 3.12:

- Incompatibility with Archer of Sylvanus spelled out.
- WeiDU 203 - installable over the Morituri kit.

?? - Version 3.11:

- WeiDU V 202.
- Chloe's weapons are usable by her again.

?? - Version 3.10:

- WeiDU V 200.
- Can choose to install Armor Revision without movement rate penalties.
- Kit-editing code heavily changed - should be more mod-friendly and reliable.
- Moved code for longer components in INCLUDEd files for better readability.
- Probably some install-time (or game-time) fixes.

16 January 2006 - Version 3.02:

- WeiDU v188 contains a vital bugfix.
- SwashImoen will no longer report as a Fighter/Mage.
- Infinite loop at install-time solved.

25 December 2005 - Version 3.01:

- An attempt to fix the bard songs. Our engine is struggling to be uncooperative, sadly, which means that issues will arise from time to time.
- New subcomponent: swashImoen has Detect Illusions rather than Set Traps.
- New subcomponent: heal on morphing to animal form, rather than on morphing back to human. This component was coded by Borsook.
- Armors from the Ashes of Embers mod are patched by AR. Scale are assimilated to Hide, Banded to Splint, and Field to Plate, except that plate starts from 2 AC rather than 3. This may not be 100% realistic, however AR was coded with the equation 'higher base AC = heavier' in mind.
- WeiDU v187 allows me to code sligtly different choices more easily, so part of the nonsense when installing the Armor Revision is removed. Also, a number of other changes for faster installation.
- Polish Translation by Yarpen.

17 October 2005 - Version 3:

- Added the Armor Revisions component!
- XP cap remover added to the HLA component.
- Fixed two entries in Diviner HLA table.
- *Good* Celestials don't cast Globe of Blades any longer, to avoid the risk of causing harm to the party.
- Added an alternate SwashImoen, which will just change her kit.
- Trueclass thieves now correctly "forget" thief innates upon dualling to Fighter or Cleric (until reactivation of the starting class).
- Added a small tweak to allow compatibility between the SA component and Kido NPC.
- Rewritten most of tp2 for faster execution and shorter size.
- Fixed minor typ0es.
- Prompt customization implemented.
- SFX-RAR will auto-update and re-launch!
- Using DESIGNATED to better allow for future mod development.
- Additional notes on mod compatibility.
- HTML Readme.
- SwashImoen can now work without the Revised HLA component or TOB installed.
- French translation by Sir Crapoilleau.
- Japanese translation by Kuroukume Veland.

10 May 2005 - Version 2.01:

- Fixed three little problems with the installer.
- Fixed a problem with the code for the Cleric-Remix mod compatibility.
- Endurance slightly reworked, nasty bug killed.
- Racial Nemesis fixed (it wasn't applied at all...).
- Various fixes to the scripts.
- Minor fixes to Divine Intervention.
- Fixed a nasty new bug with Merciful Fighting.
- Various additional improvements to the installer.
- Elven Sword Angels are now allowed.
- Shapeshifters who dual to fighter after picking Feral Spirit no longer gain additional forms upon reactivation of the kit.
- Fixed a pathological case where a Sword Angel/Mage was actually able to learn the 10th level spell Death Field.
- Adjustments to the regeneration rates for shapeshifters' werewolf forms.
- Fixed a bug with Regeneration (Monk and Sword Angel).

20 March 2005 - Version 2:

- "Shockwave" for Sorcerers added.
- Extended compatibility with kits added by other mods. Compatible kits now include:
  * Generic Archer, Anti-Paladin (Tactics mod)
  * Peerless Archer (Warrior Kit Pack)
  * SharpShooter
  * Selune, Shar, Tempus (Cleric Remix mod)
- Ancestral Spirit now has a specific script.
- Dynamic Weapon Proficiencies component added.
- Save required by Quivering Palm changed to save vs. Death.
- Faster than the Eye visuals improved.
- Evasion and Greater Evasion are no longer stackable.
- Precision and Tracking have been slightly rebalanced.
- Fixes to Animal Affinity, Acrobatic, Inner Focus, Sustaining Will.
- Merciful Fighting implemented again with a better system.
- Monk HLA table entirely rebuilt, with several new abilities.
- "Finesse" for Blades added.
- Removed a bug concerning Energy Storm and the Free Action effect.
- Fixed a couple of bugs with the druidic elemental forms.
- S.A. can no longer score critical hits while using Merciful Fighting.
- Added "Toughness" and "Improved Critical".
- Minor adjustments to the settings of various tables.
- Removed a bug with the installer (thanx Sim!)
- Killed a nasty bug introduced by our fix for Spell Shield (ehm...)
- Brew Poison re-implemented, now gold is consumed by the process.
- Various fixes and improvements to the installer.
- Added a small "fix" to the projectile used by Meteor Swarm.
- Sword Angel's HLA Banish slightly rebalanced.
- Adjustments and visual changes to Shield of Law and Circle of Law.
- Added "Holy Aura"; applied further adjustments to the Paladin's tables.
- Improvements to Dragon Fist visuals.
- New visuals for Whirlwind Attacks.
- Added "Freedom of Spirit", "Soul Touch" and Improved Critical to the Sword Angel's table.
- Fallen Paladins now lose any previously acquired HLA added by Refinements.
- "Elemental Transformation" added; further adjustments and bugfixes related to shapeshifting.
- "Whirlwind" for druids added.
- Fixed a bug with Endurance.
- Dynamic Weapon Proficiencies component merged with the HLAs system.
- Added "Combat Reflexes", "Resist Magic Damage", "Slippery Mind" and "Feral Lash" (multiclass specific abilities).
- Repulse Undead replaced by "Smite Undead" for Undead Hunters.
- "Concealment" for Cleric/Thieves added.
- Swashimoen has now a dynamic installer (to grant wider compatibility).
- Robe of Vecna slightly tweaked for sorcerers.
- Summoned Magic Golems are now immune to magical weapons.
- Added "Racial Nemesis" for Rangers.
- Extended the list of item mods checked by the Sword Angel's installer. The list now includes:
  * Rogue Rebalancing
  * Item Upgrade
  * Ruad
  * Freedom's Reign
  * Reign of Virtue
- "Union" for Cleric/Mages added.
- Wildstrike rebalanced and fixed (the penalty to the wild surge roll is now actually applied). New visuals implemented, too.
- Finally included the newly and entirely revised Celestials!
- New visuals for Teleport Without Error (used by the Revised Elemental Princes and the Revised Celestials).
- Toxic Trap's venom is now cleared by Zone of Sweet Air (or a druid's Whirlwind).
- "Recitation" for Clerics added.
- Divine Intervention slightly revised.
- New scripts for our Celestials, Elemental Princes, Demons and other creatures.

30 June 2004 - Version 1.05:

- Removed the components "World Map Fixes" and "Weapon Animation Tweaks": they're now exclusively included in G3 Tweak Pack (www.gibberling3.net).

25 June 2004 - Version 1.04:

- Repulse Undead now appears properly for Undead Hunters.
- Cavalier's Virtue is now applied correctly.
- True Kai changed to use the "rising" spirit animation when needed.
- Aura Cleansing's casting time raised to 9.
- Fixed the wrong setting of SwashImoen's AC.
- Removed a nasty "feedback-bug" with Shadowless Kick.
- Fixed (again!) a bug with Wong Fei's Ioun Stone and the Sword Angel component.
- Added a 2 rounds Miscast effect (no-save) to Spell Worm.
- Improvements to the installing procedures (for better compatibility).
- TONS of refinements and additions to some creatures' scripts: HUGE WORK done by the_bigg, who joined the team for future components!

8 May 2004 - Version 1.03:

- Divine Shell now properly works and is undispellable.
- Paladins' Righteous Magic now displays the proper name.
- Channel Magic's duration increased to 3 rounds.
- Fixed some typos.

1 May 2004 - Version 1.02:

- Improvements to Volcano's visuals.
- Skalds' specialization HLAs now affect even two-handed weapons.
- Adjustments to Energy Storm's effects and visuals.

27 April 2004 - Version 1.01

- Additional fixes and adjustments to the whole druidic shapeshifting system.
- Sword Angel may no longer use the Shadow Dragon Scale.
- Fixed an issue with the Sword Angel and katanas added by external mods (the proper order of installation is still required).
- Fixed some triggers for the Sword Angel's falling.
- Good Necromancers may now summon a Planetar.
- Ancestral Spirit is no longer immune to ALL weapons.
- Just try to Shadowless Kick yourself NOW...

21 April 2004 - Version 1, second attempt :-/

16 April 2004 - Version 1

16 March 2004 - Version 1 BETA

#### Credits

This mod was made by T.G.Maestro, Littiz and (starting from 1.04) the bigg.

##### Big Thanks:

The people who made this possible, by creating amazing modding tools:

- Westley Weimer, for WeiDU and his willingness to constantly improve it.
- Jon Olav Hauglid, for NearInfinity and... as above :)
- Andrew Bridges, author of BAMWorkshop
- Gustov Montessi, author of IEEP

People who contributed (smaller or larger) portions of code to the mod:

- Caedwyr, who helped and helps a lot with his proofreading, and several new abilities, additional coding, ideas and suggestions as well.
- CamDawg, who has also been our "host" for a while :)
- aVENGER, for his concessions about the use of some material from his Rogue Rebalancing Mod. This ALSO allowed us to make Refinements compatible with his mod itself (details in "Refinements/Revised_HLAs.txt").
- Dyara, the one who originally found the correct settings for the KIT.IDS file. A really important discovery for our mod!!
- Sir Kill for his help with the new elemental forms' attack BAMs!
- Weimer (again) for the XP cap removal code.
- Borsook for the Heal When Morphing To Animal part of the Shapefix group.

Web Issues related thanks:

- Seifer, for his gracious help with web-hosting and several other issues.
- SConrad, for hosting the forum and mirroring.
- khayman, who designed and built the site :)
- Michel and TheWizard for the additional Mirrors!

Translation team:

- French Translation: Sir Crapouilleau.
- Japanese Translation: Kuroukome Veland.
- Polish Translation: Yarpen.

Miscellaneous thanks:

- Ghreyfain for allowing us to tweak his excellent Sensible Weapons (from the Ashes of Embers mod) for best interaction with the Armor tweak.
- Domi, for having coded a 'guest' interjection for the Sword Angel in her Kivan of Shilmista mod.
- Our BETA testers: Caedwyr, Caveman, Jolyth, khayman, Rathwellin the Bard, Harbinger :)
- -All the guys at the FWStudios forums (now SpellHold Studios), always helpful providers of knowledge and advices, either directly or indirectly (from our PoV). To name a few: JCompton, Idobek, Sim, GreyViper...

#### Contact Info:

We welcome any kind of bug report, incompatibility issue report, suggestion and constructive criticism, and we'll take it in highest consideration - please, keep the trolling to yourself.
The method of contacting us we prefer is via the forum, since this way all of us three and all the interested players will be able to contribute their ideas.
However, if you prefer to contact only one of us, these are the e-mail addresses:

If you turned off JavaScript and didn't see a link above, you'll have to work out the real address by hand (sorry, protecting against spammers is a necessity right now):

- Littiz: yahoo.com after the usual symbol, littiz2003 before.
- The Bigg: spellholdstudios.net after the usual symbol, thebigg before.