The Gemstone of Balance and Other Stories (GGame Engine)

by Gary Arndt


***************************************************************************
WARNING
***************************************************************************

This is a patch, NOT the game install itself.

For those who may be unfamiliar with patches, a patch typically includes only a subset of files that are needed to run a program and is intended to be installed on top of an existing install.  A patch is not intended to be used by itself.

Trying to use the patch without the base game installed will not result in a valid install.  In other words, you must first have the game installed before you can install a patch.  If you already have the game installed, then you may install this patch (even if you have installed an older patch, although to be clear, having any older patches installed is NOT necessary since the new patch includes all of their content).


***************************************************************************
What is this?
***************************************************************************

This document explains the purpose of this patch (what it fixes and/or improves), when to install it, and how it should be installed.


***************************************************************************
A note regarding version numbers
***************************************************************************

Throughout this document there are references to dates that say things like "this version or newer" or "this version or older".  In order to clarify these statements, be aware the following convention is used for versions:

YYMMDD

For example:
(and just an example; this is NOT the version of this patch!)

221214

YY = 22 (2022)
MM = 12 (December)
DD = 14 (the 14th)

So 221214 = 2022, December, the 14th

(This particular order is used because it allows the proper sorting of filenames that use such vesion numbers by putting them in the proper alpha-numerical order)


***************************************************************************
Patch notes
***************************************************************************

Overview:
- Be sure and install this patch over only the versions mentioned next in this section
- A brief list of changes is included (if you want more details, refer to the separate, full readme file)
- Actually installing the patch is explained towards the end of this section
- A few addition misc. subjects are also addressed (such as notes about the separate, full readme file and other documentation)

This patch is intended for version 240720 (or the parallel 240715, which is a patched older version) or newer versions 250322, 250309, 250301, 250214, 250207, 241122, 241115, 241111, 241107, 241101, 241026, 241019, 241012, 241004, 240926, 240919, 240909, 240903, 240825, or 240817 (recent patches or corresponding full versions).  If you want to be sure which version you currently have installed, your current version can be found in the "version.txt" file in that install's root directory.

The changes are described in the main (new) separate readme file in this patch (GGame2\README.txt), but briefly:

The following general problems have been addressed:

- A few general minor bug fixes have been made, for example the end menu appearing an extra time after a reload or load, area-based turn undead spells angering allies, a problem with the checking in some NPC conversations and other situations when a door has been unlocked after an item has been dropped, a minor memory issue with special chests that lead to encounters, an item not included in the inventory order list, multiple wrapping of view maps, character position when scrolling wrapping view maps, the arcane spell merchant wasn't responding properly to "name", some minor typo's, and a variety of other minor fixes to some NPC conversations
- Fixed problems with the special visions where items could disappear and where the target map didn't need to be saving
- Fixed some problems with the sleep condition
- Fixed a very serious bug in the autosaves that include the Planar Abode wand and the special area on the bottom level of the west continent dungeon where the exit data can be corrupted in those saves (although importantly, note that without a reload from one of those, subsequent saves are ok).  The bug fix menu option for exit data can be used to fix any corrupted exit data if you saved after reloading form one of those corrupted autosaves.  Please refer to the standard readme file if you require additional details.
- Fixed a minor bug in reading the config file when there are long comments
- Fixed a bug in combining item stacks in some cases
- Fixed a bug in the dungeon SE of Friel and the river where a new or summoned creature could cause the related quest not to be completed.  Also fixed a related bug in another dungeon room with summoned beholders.
- Fixed a bug in vehicle ammo where it incorrectly also checked to make sure there was ammo remaining for the PC's weapon rather than just the vehicle weapon's ammo
- Fixed a problem where the Move NPC command had mixed X and Y coordinates when a PC has to move and a missing line feed in the related error message
- Remaining summoned allies in the Seaport goblin lair no longer prevent quest completion
- The end sequence now properly considers a saved reload
- Fixed a problem with sleep powers affecting summoned allies
- Aborting Yell no longer uses up a turn
- Fixed some problems with wrapping maps vs. some features such as area spells
- It is no longer possible to take an action when reloading from a save where the PC or party is dead
- A general bug was fixed that was accidentally introduced in version 241012 where the view no longer was set properly in dungeon rooms with certain special characteristics
- The rainstorm in the village near the keep now does not happen with every load but rather just when entering


The following problems with the party system have been addressed:

- A variety of minor bug fixes have been made to the party system, for example a problem in a split party with HP not always updating after an attack, a problem when split with the "move NPC" command going to the PC position, a problem with "on other" spells being allowed on maps where they should not, a problem after a pit trap with a party member still listed as delayed, and a problem in the party stats command with the wrong sidebar data being listed afterwards
- As part of integration with scenario 2, a number of particular maps continue to be enhanced or changed to work properly or at least work better with regards to the party system
- Fixed some party-related problems with the sleep condition
- Fixed party-related problems with some mystic points
- Fixed a bug where several Party sub-commands when used without a party would cause a crash
- Fixed a bug in the feature to skip disabled party members where the first party member would sometimes incorrectly appear in place of another
- The particular party member target of a power is now made clear via new or enhanced messages
- Talking to the rogue that joins no longer causes an error message when there is an existing party
- The end sequence now properly considers a party
- The final battle is now more properly balanced for a party
- Split no longer will place party members beyond walls and such
- Fixed a problem with the Seaport theater and the character tile becoming black (if you have a saved game with this problem, rest or board/exit a vehicle)
- Fixed a variety of problems with wrapping maps vs. party system features such as the display of party members across a wrapping border
- Fixed a bug where the sidebar sometimes after resting showed SP and no title for a character without SP
- Fixed a bug where only the active party member was being checked for a level increase when gaining XP (all still gained XP, however)
- Fixed a bug where the delay on a split party member would persist after unsplitting (now moved to the active char and resolved immediately)
- Dead party members now display properly
- Some related bugs when using a party have been fixed where the wrong party member was in some cases used for things such as the visual for a special power during an attack and the reduction of weight as food is used up (and a new bug fix menu option for recalculating inventory weight has been added)
- Various critical bugs when using a party for dungeon rooms and other parts of scenario 2 have been fixed (although more testing is needed in case there are more of these)
- A critical bug regarding using a party and potentially losing exit data in a very few locations
- A critical bug regarding using a party and potentially losing game flags has been fixed and a new bug fix menu option added for the sake of any games in progress
- It is no longer possible to cast spells such as Heal Other on a dead party member
- The saving of having used the disband option has been fixed


The following general enhancements have been implemented:

- A few minor improvements have been made such as various checks for nearby danger now work in a circle rather than a square, a cast spell name will now be displayed after selection, some enhancements to the planar abode, some areas now transitioned to a more intelligent AI setting already used by other areas (the term "AI" meaning this game's own code that controls enemy/NPC movement and combat choices), a negative modifier now being included as a condition, and a variety of minor improvements to some NPC conversations
- User settings have been moved from scenario1.dat to scenario-user.cfg; please refer to the notes later in this section for details (search for "user scenario settings").  Note that some additional improvements were made later, first the user file being made optional with a warning when the file was missing, then later the warning being removed in favor of a message optionally being displayed when the file IS loaded.
- The main menu character creation option now has support for pregenerating characters (in scenarios that are configured to support this, currently just scenario 2)
- There are now some alternate methods to select a spell
- Area effect powers for creatures has now been implemented and a few creatures now use these instead of single-target powers
- Show Object State now includes a new "DISABLED" option that will show delay, sleep, etc.
- Control-M now supports allies that are not engaged in combat


The following enhancements related to the party system have been implemented:

- A variety of minor improvements have been made to the party system, just a few of which include trade when split, adding a party pass command, Look on a party member including all conditions, combat messages displaying the party member in question, delay being included in Z-stats (since it shows up when using this on another party member), Party Wait being included as a condition, Party Wait now being unset when the party is unsplit, and the "NO PARTY" message now being more consistent between the various sub-commands
- As part of integration with scenario 2, a number of particular maps continue to be enhanced to work better with regards to the party system
- The 'Z' command now supports additional functionality such as using the arrow keys, shortcut keys, and a party screen
- The main menu character creation option now has support for creating your own party (no built-in scenarios are currently configured to directly support this, but custom scenarios may now use it, plus it can be activated as a new cheat setting for scenarios that support a party at all such as scenario 2)
- The conversations for the quest in Harborside now better support both a party and a cleric
- The active character can now be changed when in a vehicle
- Added a party "Wait" command (while useful for general purposes, done largely to improve gameplay on some particular maps)
- The checking of valid conditions for unsplit have been enhanced to work in a circle rather than a square for distance, to require party members to be in closer proximity to each other, and on standard maps to not be near danger
- A new party option has been introduced that will skip view shifting to characters that are disabled by delay or sleep
- The party system is now essentially implemented and integrated into scenario 2 (however, be warned that more things still need to be tested with respect to the scenario 2 integration and any associated fixes made so this is currently for playing with the understanding that there's a chance disbanding the party may be needed to continue if you run into such a problem).  Like previous patches, this newer patch also includes significant additional progress on that implementation.  Most recent work, additional work that may still be needed, and additional testing that is needed is with regards to the integration with scenario 2.


Special notes:

- User scenario settings for scenario 2 (although NOT the other scenarios) have been moved from scenario1.dat to scenario-user.cfg; if you made any changes to any user scenario settings in that file then you will need to redo them in the new file (assuming you still want those changes).  This move of those settings should prevent needing to redo any user scenario settings in the future (meaning, for patches; entirely new installs would of course still require redoing custom settings).  Please refer to the standard release notes document if you need additional details.
- The main new readme (GGame2\README.txt) now provides additional details regarding when (in scenario 2) an NPC that will join will accept or decline.  In particular, there is a minimum level requirement, the NPC will decline if it is the same class, and there are other NPC's that will join (meaning, any class can be used for your primary character and there will still be other NPC's that are willing to join).


When this patch is applied to version 240720 (or 240715), or a previously patched version (or corresponding full version) 250322, 250309, 250301, 250214, 250207, 241122, 241115, 241111, 241107, 241101, 241026, 241019, 241012, 241004, 240926, 240919, 240909, 240903, 240825, or 240817, it will apply the changes.  Note that this patch includes the content of the previous patches 250322, 250309, 250301, 250214, 250207, 241122, 241115, 241111, 241107, 241101, 241026, 241019, 241012, 241004, 240926, 240919, 240909, 240903, 240825, and 240817; it is NOT necessary to apply any of those earlier patches prior to applying this one (although having one already applied is fine).

WARNING: DO NOT apply this patch to any versions other than those mentioned above

A special clarification related to version 240715 (this is NOT an issue with version 240720 or newer, meaning this note can be ignored if you are not using version 240715 or older): Installing this patch over version 240715 is correct.  Version 240715 is itself a patch that can be applied to a number of older versions.  However, this patch does NOT include the changes included in 240715.  Therefore, do NOT install this patch directly over versions older than 240715; the older changes are assumed to have already been installed via patch 240715.  In any case, this will not NOT be a problem if you install this patch over only the specified versions (which includes 240715).  If you have an older version supported by patch 240715 (such as 240607, 240519, etc.) then you will have to install that patch first before installing this newer patch.


There are 2 steps to install this patch:

1: Simply copy all files from the GGame2 directory of this zip file over the existing files in your install (make sure your copy process includes the subdirectory structure so the files all end up in the corresponding subdirectories).  That said, you may optionally want to consider first backing up or renaming the older versions of the files to be updated.  If you choose to leave the older versions of those files in place then be aware that the copy process will likely warn you that you are about to overwrite those files.  Doing so is correct; the new versions need to replace the old versions.

2: This step is entirely optional; you may skip it if you want to do so.  Anyway, if you already have a DATA2\scenario-user.cfg file, then you are done unless you wish to integrated any new changes from an updated scenario-user-new.cfg file.  Doing so is entirely optional.  If you do not yet have a scenario-user.cfg file, then you may rename scenario-user-new.cfg to scenario-user.cfg if you wish to use any of those settings.  Again, doing so is entirely optional.  If you want to verify that file is being loaded (and thus your custom settings being loaded), uncomment the message setting at the beginning of that file ("M:").  Note that some older versions such as 250322 issued a minor warning message when the scenario started if scenario-user.cfg was missing, but that behavior has been changed; it will no longer issue a warning.  Instead, the behavior has been reversed so that rather than a warning if the file is NOT being loaded (because it is missing), you can enable that message if you want to verify that the file IS being loaded.


Note that this patch includes a new version.txt file; applying this patch updates your install to the new version specified in that file.

Further, the new GGame2\README.txt file (not to be confused with the file you are currently reading) contains more details about this new version and the related issues/changes.

Lastly, it is worth noting that there is signficantly more detail about how to start the game, play the game, etc. in other documents.  A good place to start is the afore-mentioned separate full readme file, but note that there is also built-in help / quick reference guide (via the traditional Window help key, F1, and note there's also an export available for that in case you want to read it in a separate program or print it), a full manual, a hints document, and an install document for the base game's install.  By no means does all of that rather extensive documentation need to be read ahead of time in order to play; suggestions on what to read ahead of time are location in the full readme file.
