Revisions (patches and tweaks) for Spell Revisions.
This repo is now deprecated. All the SR fixes are included in the most recent version v4.19rc1 and the tweaks have been moved to Spell Revisions Tweaks.
This is a standard WeiDU mod, so no special instructions, but to recap: if you either git clone or download the latest public release, just copy the mod to your Baldur's Gate install and weinstall spell_rev_rev in the command line (or use an automatic installer like PI).
note(s):
- if you are downloading the mod by clicking the code button at the GitHub page, then the main folder is named "spell_rev_rev-main" -- this is a GitHub thingy. Rename it to "spell_rev_rev" or else the mod will not work. Similarly, public releases may append the version to the folder name, just rename the main folder to "spell_rev_rev" and you are good to go.
Spell Revisions is obviously necessary; use the latest v4 beta 18 release. The mod uses EE features, so it does not work on classical editions or platforms like BGT that rely on it. It was also tested with the game patched to version v2.6, so if you have an earlier version you might see some differences.
The mod is pure WeiDU, so it should be safe from operating system variations. While it was tested in linux, using a case-insensitive ext4 partition -- see here for details on how to set it up -- it should work just fine on Windows or MacOS. If it does not, patches are welcomed.
As far as load order, it should be installed right after Spell Revisions. The mod was also tested with all SR components installed with the exception of Update NPC Schoolbooks, which is irrelevant as far as this mod is concerned, and Spell Protections protect against AoE spells. I do not use use this component myself, but I expect it should not introduce any major complications -- if you find that it does, patches are welcomed.
There are currently, two components in this mod.
The patches component patches the spells introduced by Spell Revisions. User-convenient documentation for the patches applied can be found in the readme, while a list of to-dos can be found in the todo file. Consult this file before submitting an issue or patch.
The tweaks component tweaks the spells introduced by Spell Revisions. The difference between a tweak and a patch can be blurry; suffice to say that we have been as conservative as possible when it comes to patching SR. Any change of gameplay functionality counts as a tweak and is in this component. The changes tend to be fairly low key, in part because SR is already just fine as it is, in part so as not to needlessly confuse SCS. Most of them are borrowed almost verbatim from SR Revised. For fuller documentation on each tweak consult the readme.
If you want to contribute, an overview of the code is useful.
The patches component is designed to only patch spells that have entries in the spell.ids file. Each such patched spell has an entry in the patches table .2da file. The columns of the table are the symbolic name, a patch flag (that the user can toggle for fine-grain selection of patches) and a tra reference for the new spell description. The code iterates through the table, and for each entry, if the patch flag is enabled it copies the new description if any (e.g. tra reference is different from 0) and applies the patch function with the same spell symbolic name. The function is found in the relevant tpa file, organized by arcane/divine and level for ease of maintenance. Everything is done in the patch function, including the copying of any needed resources, patching of auxiliary resources, etc.
Besides the original spell_rev authors and maintainers, special shout out to:
- ALIENQuake: WeiDU 247 work-around patch.
- Bartimeus: discussions, ideas, the fixed icons, and many other things that I have already forgotten.