dropped tips, moved license and changelog into separate files

BGforgeNet · Feb 8, 2020 · 6038110 · 6038110
1 parent 90929c4
commit 6038110
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -20,8 +20,8 @@ It's designed for BG series. It might work on other IE games, but that's unteste
   - [Spellshaper kit](#spellshaper-kit)
   - [Misc spell changes](#misc-spell-changes)
 - [Tips](#tips)
-- [Changelog](#changelog)
-- [License](#license)
+- [Changelog](docs/changelog.md)
+- [License](docs/license.md)
 
 ### New wild magic spells
 - [Ironman](#ironman)
@@ -57,12 +57,12 @@ The Spellshaper is meant to be a kind of "rogueish" mage (or a "magey" rogue) as
 
 #### Original avatar
 The Spellshaper will look like a regular mage.
+
 #### Changed avatar
 - Female Spellshapers use the Thief avatar
 - Male Spellshapers use the Cleric avatar
 
 ### Misc spell changes
-
 This component is independent of the other components, and modifies some of the original spells:
 
 #### Magic Missiles
@@ -71,51 +71,7 @@ The missiles now always do 1d4+1 points of damage, as they're supposed to. Origi
 #### Dimension Door
 Like dozens of other wizards in the game, you now can target any nearby place you've already visited. There no longer needs to be a clear path within the caster's viewing distance that leads to the destination-area. You can select any place within the area where you've been already. (This component doesn't include scrolls to learn the spell, if you don't play a spellshaper you need another mod, or use Shadowkeeper to learn the spell or get the scroll).
 
-### Tips
-- Rhialto will always spawn. It doesn't matter which class is the main character.
-- How to kill him on low levels, (BG1 ironman):
-  - gather a larger party
-  - spread, run, shoot
-- In pansy mode, Rhialto is in the actual Candlekeep area, not in the area where Gorion is killed.
-
 ### Report issues
-- Check [not bugs/known issues](#not-bugsknown-issues).
+- Check [not bugs/known issues](docs/known_issues.md).
 - Check [reported issues](https://github.com/BGforgeNet/bg2-wildmage/issues?utf8=%E2%9C%93&q=is%3Aissue).
 - If it's not present there, file a new one.
-
-#### Not bugs/known issues
-- "Summon Cow" occasionally damages every creature in the whole area. This seems to be hard-coded and intended by Bioware. It also happens with the wild surge and the original 2nd level "Easter Egg"-spell.
-- Spellshaper *does not* get extra attacks from weapon specialization. If you're unhappy with that, post [here](https://github.com/BGforgeNet/bg2-wildmage/issues/2)
-- "Weave Spell" acts a bit strange with wizard spells from other mods: as long as you still have original Bioware-spells or spells from this mod memorized, using "Weave Spell" will drain the modded spells from memory just like the others, but when there are only modded spells memorized, you can't use the "Weave Spell" ability.
-- Items that raise the number of Spell-Slots, when worn by a Spellshaper, might cause him to forget all spells of tbe modified level upon resting. This seems to be an engine-glitch, and I have no idea how to fix it. The solution is simply NOT to wear such items (they definitely don't work for a Spellshaper)
-- When a Spellshaper is level-drained, he may get bonus-spell-slots, when the game resets his number of spells. Once he is restored to the old level, the number of spells is also restored. The only way to "fix" this seems to grant the Spellshaper permanent immunity to level-drain...
-- Right after a Spellshaper advanced to 20th level, he is stunned for a second. This happens on purpose, to prevent you from equipping a Ring of Wizardry while the "Hand"-item (which normally prevents you from using Metamagic items) is exchanged in order to actualize the char's number of memorizable spells.
-
-### Changelog
-- 2.beta3
-  - Better EE compatibility with HANDLE_CHARSETS
-  - Updated some translations
-- 2.beta2
-  - Fixed problem with Rhialto never polymorphing
-  - Added separate component to preserve the bear
-  - Fix tutu installation
-- 2.beta1
-  - Allow to be installed on EE (including IWD:EE)
-  - Make MacOS/Linux friendly
-  - Combine some components to simplify installation
-  - Preserve teddy bear upon BG1>BG2 transition
-  - Fix Rodent/Ratatosk shape: power, dispell/bypass, AC bonus, paw enchantment, description
-  - Fix Random spell X description
-  - Fix Rhialto's spell slots/levels
-  - Fix Blade shower: no permanent daggers, bypass magic protections such as GoI, clarify description, disable wild surges/spell failure for created daggers
-  - Under the hood: dos2unix, lowercase, split components into multiple files, use newer weidu syntax, shorten where possible, streamline scripts handling Rhialto appearance and items transfer
-- 1.7: the original
-
-
-### License
-The original work is abandonware. JOG doesn't appear to be available.
-
-Contributions **on top** of the original are <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">
-<img src="https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-blue.svg" alt="License" />
-</a>
-
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,46 @@
+## Changelog
+
+- [Version 2](#version-2)
+- [Version 2.beta3](#version-2.beta3)
+- [Version 2.beta2](#version-2.beta2)
+- [Version 2.beta1](#version-2.beta1)
+- [Version 1](#version-1)
+
+### Version 2
+- Vortex:
+  - made sure PnP free action doesn't override hold.
+  - made sure it has sounds on BGEE.
+- Corporeal instability: added missing poison immunity.
+- Some translations updated.
+
+### Version 2.beta3
+- Better EE compatibility with `HANDLE_CHARSETS`.
+- Updated some translations.
+
+### Version 2.beta2
+- Fixed problem with Rhialto never polymorphing.
+- Added separate component to preserve the bear.
+- Fixed TuTu installation.
+
+### Version 2.beta1
+- Allowed to be installed on EE (including IWD:EE).
+- Made MacOS/Linux friendly.
+- Combined some components to simplify installation.
+- Preserved teddy bear upon BG1>BG2 transition.
+- Fixed Rodent/Ratatosk shape: power, dispell/bypass, AC bonus, paw enchantment, description.
+- Fixed Random spell X description.
+- Fixed Rhialto's spell slots/levels.
+- Fixed Blade shower
+  - no permanent daggers
+  - bypass magic protections such as GoI
+  - clarify description
+  - disable wild surges/spell failure for created daggers
+- Under the hood:
+  - dos2unix
+  - lowercase
+  - split components into multiple files
+  - used newer weidu syntax, shortened where possible
+  - streamlined scripts handling Rhialto appearance and items transfer
+
+### Version 1.7
+The original.
diff --git a/docs/known_issues.md b/docs/known_issues.md
@@ -0,0 +1,7 @@
+## Not bugs / known issues
+- "Summon Cow" occasionally damages every creature in the whole area. This seems to be hard-coded and intended by Bioware. It also happens with the wild surge and the original 2nd level "Easter Egg"-spell.
+- Spellshaper *does not* get extra attacks from weapon specialization. If you're unhappy with that, post [here](https://github.com/BGforgeNet/bg2-wildmage/issues/2)
+- "Weave Spell" acts a bit strange with wizard spells from other mods: as long as you still have original Bioware-spells or spells from this mod memorized, using "Weave Spell" will drain the modded spells from memory just like the others, but when there are only modded spells memorized, you can't use the "Weave Spell" ability.
+- Items that raise the number of Spell-Slots, when worn by a Spellshaper, might cause him to forget all spells of tbe modified level upon resting. This seems to be an engine-glitch, and I have no idea how to fix it. The solution is simply NOT to wear such items (they definitely don't work for a Spellshaper)
+- When a Spellshaper is level-drained, he may get bonus-spell-slots, when the game resets his number of spells. Once he is restored to the old level, the number of spells is also restored. The only way to "fix" this seems to grant the Spellshaper permanent immunity to level-drain...
+- Right after a Spellshaper advanced to 20th level, he is stunned for a second. This happens on purpose, to prevent you from equipping a Ring of Wizardry while the "Hand"-item (which normally prevents you from using Metamagic items) is exchanged in order to actualize the char's number of memorizable spells.
diff --git a/docs/license.md b/docs/license.md
@@ -0,0 +1,4 @@
+## License
+The mod is updated with permission from the original author (JOG).
+
+Contributions **on top** of the original are [![license](https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-blue.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/).