Skip to content

Commit 092deb5

Browse files
committed
README clarifications (hopefully)
1 parent e4d93c4 commit 092deb5

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,21 @@ Revisions (patches and tweaks) for Spell Revisions.
44

55
## A. Installation.
66

7-
First, download and install the gr-lib WeiDU library -- consult the [readme](https://github.com/lambda-dom/gr-lib) for more details. Then install the mod just like you would install any other WeiDU mod.
7+
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).
8+
9+
note(s):
10+
* if you are downloading the mod by clicking the code button at the GitHub page, then the main folder is name "spell_rev_rev-main". Renamed it to "spell_rev_rev" or else the mod will not work.
811

912
## B. Requirements.
1013

1114
[Spell Revisions](https://github.com/Gibberlings3/SpellRevisions) 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.
1215

13-
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.
14-
1516
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](https://www.gibberlings3.net/forums/topic/28516-the-linux-users-guide-to-installing-mods-on-the-enhanced-editions/) for details on how to set it up -- it should work just fine on Windows or MacOS. If it does not, patches are welcomed.
1617

18+
### B. 1. Load order.
19+
20+
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.
21+
1722
## C. Components.
1823

1924
There are currently, two components in this mod.
@@ -34,7 +39,14 @@ If you want to contribute, an overview of the code is useful.
3439

3540
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.
3641

37-
## E. Tools used.
42+
## E. Special Thanks.
43+
44+
Besides the original spell_rev authors and maintainers, special shout out to:
45+
46+
* ALIENQuake: WeiDU 247 work-around patch.
47+
* Bartimeus: discussions, ideas, etc.
48+
49+
## F. Tools used.
3850

3951
* [WeiDU](https://github.com/WeiDUorg/weidu)
4052
* [Near Infinity](https://github.com/Argent77/NearInfinity)

0 commit comments

Comments
 (0)