-------------------------------------------------
---                  Framed                   ---
---             for BGEE and EET              ---
-------------------------------------------------


------------------------------------------------------------------------
GENERAL DESCRIPTION
------------------------------------------------------------------------
This mod requires BGEE or EET

The Framed mod provides 2 different versions of Chapter 6 and makes going to Candlekeep a possible side quest not involving the Iron Throne.  If Candlekeep is visited before the Iron Throne Building is investigated, Eltan will have a different task for the group to be done in Chapter 6.  To experience the new version, a work order will need to be obtained from Bentley (Friendly Arm Inn) or Scar (initial meeting only and only if PC admits to clearing the Nashkel minds) during Chapter 5.

------------------------------------------------------------------------
COMPATABIITY NOTES
------------------------------------------------------------------------
There are no known compatibility issues at this time

------------------------------------------------------------------------
INSTALLATION
------------------------------------------------------------------------
Install after BG1NPC (https://www.gibberlings3.net/mods/npcs/bg1npc/)
Install after BG1RE to complete Camryn/Tamah (https://www.gibberlings3.net/mods/npcs/bg-romantic-encounters/)
Install before Grey the dog (https://www.gibberlings3.net/mods/npcs/grey-the-dog/)

Installation using Project Infinity (https://forums.beamdog.com/discussion/74335/project-infinity-mod-manager-for-baldurs-gate-icewind-dale-planescape-torment-and-eet) will ensure this and other mods are installed in the correct order.

NOTE: If you've previously installed the mod, remove it before extracting a new version. To do this, uninstall all previously installed components and delete the mod folder and executables. 

When installing or uninstalling, do not close the DOS window by clicking on the X button! Instead, press the Enter key when instructed to do so.

IMPORTANT FOR EET INSTALLATIONS: EET_End will need to be reinstalled after installing this mod.
 
General (Windows, Mac OS X, and Linux)

Extract the contents of the mod archive to your game's main directory. 

Windows
On successful extraction, there should be a framed folder and a setup-framed.exe file in your game folder. To install, simply double-click setup-framed.exe and follow the instructions on screen.
Run setup-framed.exe in your game folder to reinstall, uninstall or otherwise change components.

Mac OS X
The mod is packaged and installed with WeiDU. To install, extract the mod archive, then copy of the contents of the folder into your game folder (the folder which contains the CHITIN.KEY file). If properly extracted, you should have a "framed" folder, setup-framed, and setup-framed.command in your game folder. To install, simply double-click setup-framed.command and follow the instructions on screen.

Linux
Extract the contents of the mod to the folder of the game you wish to modify. Download the latest version of WeiDU for Linux from https://github.com/WeiDUorg/weidu/releases and copy WeiDU and WeInstall to /usr/bin. Following that, open a terminal and cd to your EET installation directory, run 'tolower' and answer Y to both queries. You can avoid running the second option (linux.ini) if you've already run it once in the same directory. If you're unsure, running tolower and choosing both options is the safest bet.
Run WeInstall framed in your game folder to install the mod. Then run wine BGMain.exe and start playing. 

If you have installation problems or encounter any bugs, please post your bug report in the forum thread: https://www.gibberlings3.net/forums/topic/32638-framed-alternate-chapter-6-for-bgee-and-eet

------------------------------------------------------------------------
CREDITS
------------------------------------------------------------------------
* BeamDog / Overhaul Games: for the Infinity Engine and inspiring this mod
* K4thos: for EET - even though it's not required for this mod, I just really like EET
* DavidW: for the lovely macros included in alter_script.tpa as well as guidance on encapsulation and immutability
* Grammarsalad, subtledoctor, grodrigues, Mike1072, and jastey: for the ideas, guidance and help on the tool that provides proper and upper case player1 pronouns (cases.tpa)
* JohnBob for the French translation
* Bubb and CamDawg - LOVE YOU FOREVER!!!  I mean it.  Forevah!
* jastey: for everything you've done and continue to do. :)
* The folks at The Gibberlings Three forums: for never failing to answer my many many questions

------------------------------------------------------------------------
USED TOOLS AND RESSOURCES
------------------------------------------------------------------------
The Framed mod was created using the resources provided by the IESDP (https://gibberlings3.github.io/iesdp/index.htm) and with the following software:

* Near Infinity				https://github.com/Argent77/NearInfinity/releases/latest
* WeiDU						http://www.weidu.org
* Audacity					https://www.audacityteam.org
* Real-Time-Voice-Cloning	https://github.com/CorentinJ/Real-Time-Voice-Cloning

Modding communities, tutorials and technical assistance:

The Gibberlings Three	http://gibberlings3.net

------------------------------------------------------------------------
HISTORY
------------------------------------------------------------------------
v1.0 - initial releases
v1.1 - brought CRE DV changes up to standard
v1.1.1 - just corrects comments and the forum and download links inside the ini file. No code changes.
v1.1.2 - updated this readme
v1.2 - corrections to the Keeper of the Portal's and Arkansis placement as well as a journal correction with cross-mod content (Camryn and Tamah)
v1.3 - moved Tamoko to outside of Iron Throne bldg for alternate ch6, FF can no longer follow out of IT HQ, fixed Eltan dialogue leading to altCh6, matched journal entries to existing ones, new chapter starts now make appropriate save games
v1.4 - improved chapter saves so reloads are smoother
v1.5 - updated this readme to include credit to Audacity for making the sound files, skipped the quest entry for going to Gorion's room, closed out the Investigating the Iron Throne quest in the journal when documents found, removed Tamoko changes, allowed FF to once again follow out of IT HQ, put in alternate diaries properly (leaving in original if normal ch 6 is done), smoothed out chapter transitions
v1.5.1 - updated this readme to include the changes in v1.5 in history
v1.6 - new versions of the chapter text narrations built using Real-Time-Voice-Cloning and Audacity
v1.7 - Tethtoril will hand the PC Gorion's scroll when they finish clearing out the catacombs when BG1NPC is installed to be more compatible with it
v1.8 - added cross mod compatibility with Transitions and Sarevok's diary for Cythandria's clean-up quest
v1.8.1 - added LableType in ini for installing with Project Infinity (https://forums.beamdog.com/discussion/74335/project-infinity-mod-manager-for-baldurs-gate-icewind-dale-planescape-torment-and-eet)
v1.9 - added check for Gatewarden in quest wrap dialogue with Tethtoril
v1.9.1 - updated ini file to point at new download location
v1.10 - fixed incompatibility with Unfinished Business mod and placed Scar's giving of work order at the end of his dialogue at the bridge
v1.11 - tightened up the dialogues in the underground caverns 
v1.12 - French translation by JohnBob
v1.13 - French translation revised, by JohnBob
      - Alternative Chapter 6 should also start if the group returns after entering the Iron Throne Headquarters before going to Candlekeep in chapter 5.
      - Updated install order syntax for PI
v1.14 - Chapter change should not be initiated in Iron Throne Head Quarters if Candlekeep was done the normal way.
      - Optimized patching of DELTAN.dlg (I_C_T instead of EXTEND_BOTTOM + added transactions). 
------------------------------------------------------------------------
LEGAL INFORMATION
------------------------------------------------------------------------
Framed is unofficial Fan Content permitted under the Fan Content Policy. Not approved/endorsed by Wizards. Portions of the materials used are property of Wizards of the Coast. ©Wizards of the Coast LLC.
This mod is also not developed, supported, or endorsed by BioWare, Black Isle Studios, Interplay Entertainment Corp., Overhaul Games or Beamdog. All other trademarks and copyrights are property of their respective owners.

