52 replies to this topic

[The Imp]

Do you use a Global as a marker if the player goes through the skip ? If yes, what ?

And what's the containers name that drops all the items ? Or what ever you use--- Asking cause ... mods could add their stuff to that spot if the player chooses to skip, and only if then.

Edited by The Imp, 15 August 2016 - 08:59 AM.

[Argent77]

No globals or other hacks. I'm using the very useful script action MoveContainerContents() to transfer pretty much everything from the dungeon to the surface. The script code is generated at install time, so even mod-added items and containers will be considered.

For special stuff like items created or given via script actions I have provided the option to place 2DA tables into a subfolder of my mod which describe how to handle the items in question. All files in that subfolder will be processed when the mod is installed. It's described in much more detail in the mod's readme, including example code.
 
Link to the Readme and table description

Edited by Argent77, 16 July 2021 - 04:00 AM.

[Roxanne]

No globals or other hacks. I'm using the very useful script action MoveContainerContents() to transfer pretty much everything from the dungeon to the surface. The script code is generated at install time, so even mod-added items and containers will be considered.

For special stuff like items created or given via script actions I have provided the option to place 2DA tables into a subfolder of my mod which describe how to handle the items in question. All files in that subfolder will be processed when the mod is installed. It's described in much more detail in the mod's readme, including example code.
 
Link to the Readme and table description

There is at least the Global("A7-ShortcutEnabled", "GLOBAL", 1) that handles if the portals operate normal or with the new feature. Should you decide not to use the new offer, everything stays as it was even if you have the mod installed.

[Argent77]

1. I agree that the placement can be improved. However, this container only contains items from the air elemental room (which are probably only one or two). I can try to find a better location though if it's too out of place.
2. Good idea. I'll add the option to the level 1 portals as well.
3. Good idea, too. I'll add it in the next release.
4. That aspect is causing me the same problems as the original authors of DBG. I've also mentioned it in the readme. There is currently no good way to handle NPCs universally. Some NPCs execute actions which will most likely break when I relocate them to the surface. Other NPCs will have introduction talks which don't make sense because of the changed location. I'm open for suggestions though. For now you have to pick them up the regular way before using the portal to teleport to the surface.

Edited by Argent77, 15 August 2016 - 10:14 AM.

[Roxanne]

1. I agree that the placement can be improved. However, this container only contains items from the air elemental room (which are probably only one or two). I can try to find a better location though if it's too out of place.
2. Good idea. I'll add the option to the level 1 portals as well.
3. Good idea, too. I'll add it in the next release.
4. That aspect is causing me the same problems as the original authors of DBG. I've also mentioned it in the readme. There is currently no good way to handle NPCs universally. Some NPCs execute actions which will most likely break when I relocate them to the surface. Other NPCs will have introduction talks which don't make sense because of the changed location. I'm open for suggestions though. For now you have to pick them up the regular way before using the portal to teleport to the surface.

Number 4 is an issue that DBG had before. Like stated, just relocating NPC does not work, as their introduction will be wrong (minimum). What is more is that you may loose additional contents that mods/mod NPCs add to the dungeon part of the game. The only solutions I see at this point is to a) mention it in the readme (which you do already) b) mention it in affected mod(s) readme(s) c) provide warnings for BWS users.

A problem is, that you cannot say that your mod is incompatible with those other mods because it will all depend on how a player will use the new feature.

[Argent77]

It might be possible to devise a plugin/addon system, similar to how it's currently done for the item tables, where each (script) file contains code to deal with a specific NPC. It should probably use a well-defined set of variables or functions to be able to interact with the main code. I have to see first if something like this is even doable.

Edited by Argent77, 15 August 2016 - 11:01 AM.

[Argent77]

Thanks. I'll still follow the NPC plugin idea since I could use it for Yoshimo as well.
 

[Sergio]

you are a boss for making such a mod.

[Argent77]

With the next release you can also register new areas that should be considered in the item transfer process.
 

[Argent77]

I have outlined a set of variables that will be executed for individual NPCs, so that they are properly dealt with even if you skip Chateau Irenicus.

 

My modding experience with regular NPCs is limited however. Can someone with more experience check if the provided variables are sufficient for dealing with any possible situation a custom NPC may be introduced to the party?

Let's assume we have to deal with Yoshimo in the addon script file "SkipChateauIrenicus/npc/yoshimo.tph":

Spoiler

// *** Yoshimo ***

// It is always a good idea to check for the mod NPC's existence first
ACTION_IF (FILE_EXISTS_IN_GAME ~YOSHI7.CRE~) BEGIN
  // Set to the number of desired script blocks to generate. The number should correlate with the 
  // number of defined npc_trigger/npc_action pairs.
  // Empty variables will cause the generator to skip the script block.
  // Important: You can not define script blocks that depend on variables or actions defined in a 
  //            previous block, because each block is executed in the same script pass.
  OUTER_SET num_npc_actions = 1

  // Use the array "npc_script" to define where the script trigger/action pairs should be added to.
  // You can ignore this variable if your script blocks are to be executed in the Waukeen's Promenade 
  // area script (AR0700.BCS).
  OUTER_TEXT_SPRINT npc_script_0 ~AR0700.BCS~

  // Use the array "npc_trigger" to add one or more script trigger blocks that should be evaluated 
  // in the area script defined in "npc_script" (Waukeen's Promenade by default) how to handle missed 
  // NPCs from Chateau Irenicus.
  // Important: Make sure to avoid syntax error, or the installation of the mod will fail.
  OUTER_TEXT_SPRINT npc_trigger_0
    ~!InParty("Yoshimo")
     !BeenInParty("Yoshimo")
     Global("MetYoshimo","GLOBAL",0)~

  // Use the array "npc_action" to add one or more script action blocks that are executed in the 
  // area script defined in "npc_script" (Waukeen's Promenade by default) which define how to deal 
  // with missed NPCs from Chateau Irenicus.
  // Important: Make sure to avoid syntax error, or the installation of the mod will fail.
  OUTER_TEXT_SPRINT npc_action_0
    ~SetGlobal("MetYoshimo","GLOBAL",1)
     ActionOverride("Yoshimo",SetNumTimesTalkedTo(1))
     MoveGlobal("AR0406","Yoshimo",[1368.1922])~

  // This variable is purely optional. It is added to the transition script block which transports 
  // your party to the surface. You can only set a sequence of actions without defining any triggers.
  // Important: The script actions should not add any noticeable delay, so Wait(x) or similar actions 
  //            are out of question.
  OUTER_TEXT_SPRINT trans_action ~~

  // Note: The addon script filename (without extension) will be used as part of a guard variable, 
  // so that script blocks are not executed multiple times in the same area.
END

The definitions above will result in the following script portion in AR0700.BCS:

IF
  Global("A7-ShortcutEnabled","GLOBAL",1)
  Global("A7-NPC-yoshimo","MYAREA",0)
  !InParty("Yoshimo")
  Global("MetYoshimo","GLOBAL",0)
THEN
  RESPONSE #100
    SetGlobal("A7-NPC-yoshimo","MYAREA",1)
    SetGlobal("MetYoshimo","GLOBAL",1)
    ActionOverride("Yoshimo",SetNumTimesTalkedTo(1))
    MoveGlobal("AR0406","Yoshimo",[1368.1922])
    Continue()
END

Edited by Argent77, 16 August 2016 - 05:45 AM.

[Roxanne]

I have outlined a set of variables that will be executed for individual NPCs, so that they are properly dealt with even if you skip Chateau Irenicus.

 

My modding experience with regular NPCs is limited however. Can someone with more experience check if the provided variables are sufficient for dealing with any possible situation a custom NPC may be introduced to the party?

Let's assume we have to deal with Yoshimo in the addon script file "SkipChateauIrenicus/npc/yoshimo.tph":

Spoiler

// *** Yoshimo ***

// It is always a good idea to check for the mod NPC's existence first
ACTION_IF (FILE_EXISTS_IN_GAME ~YOSHI7.CRE~) BEGIN
  // Set to the number of desired script blocks to generate. The number should correlate with the 
  // number of defined npc_trigger/npc_action pairs.
  // Empty variables will cause the generator to skip the script block.
  // Important: You can not define script blocks that depend on variables or actions defined in a 
  //            previous block, because each block is executed in the same script pass.
  OUTER_SET num_npc_actions = 1

  // Use the array "npc_script" to define where the script trigger/action pairs should be added to.
  // You can ignore this variable if your script blocks are to be executed in the Waukeen's Promenade 
  // area script (AR0700.BCS).
  OUTER_TEXT_SPRINT npc_script_0 ~AR0700.BCS~

  // Use the array "npc_trigger" to add one or more script trigger blocks that should be evaluated 
  // in the area script defined in "npc_script" (Waukeen's Promenade by default) how to handle missed 
  // NPCs from Chateau Irenicus.
  // Important: Make sure to avoid syntax error, or the installation of the mod will fail.
  OUTER_TEXT_SPRINT npc_trigger_0
    ~!InParty("Yoshimo")
     !BeenInParty("Yoshimo")
     Global("MetYoshimo","GLOBAL",0)~

  // Use the array "npc_action" to add one or more script action blocks that are executed in the 
  // area script defined in "npc_script" (Waukeen's Promenade by default) which define how to deal 
  // with missed NPCs from Chateau Irenicus.
  // Important: Make sure to avoid syntax error, or the installation of the mod will fail.
  OUTER_TEXT_SPRINT npc_action_0
    ~SetGlobal("MetYoshimo","GLOBAL",1)
     ActionOverride("Yoshimo",SetNumTimesTalkedTo(1))
     MoveGlobal("AR0406","Yoshimo",[1368.1922])~

  // This variable is purely optional. It is added to the transition script block which transports 
  // your party to the surface. You can only set a sequence of actions without defining any triggers.
  // Important: The script actions should not add any noticeable delay, so Wait(x) or similar actions 
  //            are out of question.
  OUTER_TEXT_SPRINT trans_action ~~

  // Note: The addon script filename (without extension) will be used as part of a guard variable, 
  // so that script blocks are not executed multiple times in the same area.
END

The definitions above will result in the following script portion in AR0700.BCS:

IF
  Global("A7-ShortcutEnabled","GLOBAL",1)
  Global("A7-NPC-yoshimo","MYAREA",0)
  !InParty("Yoshimo")
  Global("MetYoshimo","GLOBAL",0)
THEN
  RESPONSE #100
    SetGlobal("A7-NPC-yoshimo","MYAREA",1)
    SetGlobal("MetYoshimo","GLOBAL",1)
    ActionOverride("Yoshimo",SetNumTimesTalkedTo(1))
    MoveGlobal("AR0406","Yoshimo",[1368.1922])
    Continue()
END

Yoshimo may well be the only NPC feasible for your approach, because he has that simple pattern of never having been in party before and the option to let him join in the dungeon or send him ahead to CC on his own. Your code simulates the second option.

 

Things get much more complicated with Jaheira or Minsc for example - globals (and Locals) are set depending on actions taken while inside Irenicus' dungeon, you free them or not, you take them into party or not, their dialogues and re-joining LOCALS change based on how you dealt with them etc. In EET it gets even more complex due to the option to keep them from BG1 part of the game.

 

None of the mod NPCs you can find in those areas follows this pattern at all.

 

My argument would be - The mod is called Skip Chateau Irenicus and it does just that. Fullstop.

 

It makes little sense to skip this part of the game and then try to re-establish a game that simulates that you did not skip it. It is a mod for those players who have no interest in the contents, NPCs, actions, story told in this chapter and just want to skip ahead to Athkatla. It is a much clearer concept to keep it this way instead of creating a mixed mess of inconsistencies (Jaheira never knows about dead Khalid? Minsc has no idea about Dynaheir.) There is also  a load of interactions between joined NPCs that have contents related to stuff inside of the dungeon and will trigger out of sync.

Edited by Roxanne, 16 August 2016 - 06:25 AM.

[Argent77]

This feature is primarily intended as an option for modders who want to relocate their NPCs if Charname skips Chateau Irenicus prematurely. It's purely optional. I don't plan to include any files except for vanilla NPCs you can meet in the dungeon. Since the code is in TP2 format a modder can even add situation-specific dialog to their NPC or add/modify related scripts.

Regarding Jaheira and Minsc, I haven't decided yet if I add code for them as well. If I do then it would only affect the characters if you never met them before (i.e. when you start a new SoA game). Otherwise I assume that you intentionally leave them to their fate.

I've tested it successfully on Adrian already with the following code (although his introduction scripts and dialogs are rather straightforward):

Spoiler

// *** Adrian Sianodel by Rhaella ***

ACTION_IF (FILE_EXISTS_IN_GAME ~RH#ADR.CRE~) BEGIN
  OUTER_SET num_npc_actions = 1

  OUTER_TEXT_SPRINT npc_trigger_0
    ~!InParty("rh#Adrian")
     !BeenInParty("rh#Adrian")
     Global("rh#FirstTalk","GLOBAL",0)
     !Dead("duergar1")~

  OUTER_TEXT_SPRINT npc_action_0
    ~SetGlobal("SPRITE_IS_DEADduergar1","GLOBAL",1)
     CreateCreature("rh#adr",[2330.1070],E)
     GiveItemCreate("rh#key",Player1,0,0,0)~
END

Edit: Tested it with Yasraena as well. This is the code:

Spoiler

// *** Yasraena by Sillara ***

ACTION_IF (FILE_EXISTS_IN_GAME ~YASRAENA.CRE~) BEGIN
  OUTER_SET num_npc_actions = 1

  OUTER_TEXT_SPRINT npc_trigger_0
    ~!InParty("yasraena")
     !BeenInParty("yasraena")
     Global("YasraenaMet","GLOBAL",0)~

  OUTER_TEXT_SPRINT npc_action_0
    ~CreateCreature("YASRAENA",[2375.1130],E)~

  // setting a variable for detection purposes
<<<<<<<< .../inlined/yasraena_patch.d
  ADD_TRANS_ACTION ~yasraena~ BEGIN 0 END BEGIN 0 1 2 3 4 5 END ~SetGlobal("YasraenaMet","GLOBAL",1)~
>>>>>>>>
  COMPILE ~.../inlined/yasraena_patch.d~
END

Edited by Argent77, 16 August 2016 - 10:32 AM.

[Argent77]

New version: Skip Chateau Irenicus v2.0

Changes in v2.0:

• Relocated a container in the rubble of the destroyed building on Waukeen's Promenade to a more suitable location.
• Added more transportation options to the lower level portals in Chateau Irenicus.
• Vanilla NPCs Jaheira, Minsc and Yoshimo can be recruited later if you decide to skip them in Chateau Irenicus.
• Added German translation.
• For modders: externalized areas to consider when transferring items to the surface.
• For modders: implemented "addon" feature that can be used to deal with skipped NPCs.

[Argent77]

New version: Skip Chateau Irenicus v2.1

Changes in v2.1:

• Added Polish translation (thanks Cahir)

[Argent77]

Thanks. But Chloe is a tough nut. I've made it work, but her alternate "intro talk" is the one as if you refused her company the first time, so you probably have to pay up front to get her join you. She can be found in the "Seven Vales" Inn at Waukeen's Promenade.

Besides Adrian, Chloe, and Yasraena, are there any more mod NPCs you can encounter in Chateau Irenicus?
 

[agb1]

Mod NPCs found in Chateau Irenicus:

 

Branwen from Branwen NPC - DL http://www.arcanecoa...d/Branwenv13.7z

Devin from Les Exiles de Lunargent - DL http://legendesstudi...r/Lesexiles.rar

Genie in Geomantic Sorcerer - DL http://gibberlings3....download&id=716

Moddie from Moddie the Vixen NPC - DL http://www.baldursga...=downfile&id=60

Frennedan from Frennedan NPC - DL http://dabus.bplaced...anmod_v1_03.zip

Lester from Lester NPC - DL ftp://eros.gram.pl/bg2/Lester_NPC_v0.8.zip

Raziel from Raziel NPC - DL http://baldur.cob-bg...c/Raziel_v1.exe

Silver Star from Silver Star NPC - DL http://www.shsforums...attach_id=27852

 

And of course Chloe.  I don't know if this is a complete list - I just grepped for Irenicus in the BWS mod ini folder.

 

And of course, not all of these are EE compatible yet.

Edited by agb1, 04 November 2016 - 08:05 AM.

[Roxanne]

Thanks. But Chloe is a tough nut. I've made it work, but her alternate "intro talk" is the one as if you refused her company the first time, so you probably have to pay up front to get her join you. She can be found in the "Seven Vales" Inn at Waukeen's Promenade.

Besides Adrian, Chloe, and Yasraena, are there any more mod NPCs you can encounter in Chateau Irenicus?

There are, but they have not (yet) been converted to EE. So maybe you want to ignore them for now.

Edited by Roxanne, 04 November 2016 - 08:07 AM.

[Argent77]

The listed mods are difficult to convert for various reasons. I'll ignore them for now. Most of them are rather old, so it's unlikely they will ever be converted to EE.
 

[Argent77]

New version: Skip Chateau Irenicus v2.2

Changes in v2.2:

• Added NPC support for Adrian, Chloe and Yasraena
• Fixed harmless error messages shown during installation

[Roxanne]

New version: Skip Chateau Irenicus v2.2

Changes in v2.2:

• Added NPC support for Adrian, Chloe and Yasraena
• Fixed harmless error messages shown during installation

Short question

I have recently started work on Chloe (abandoned by original author) to make her compatible with BG2EE and EET and also to develop further contents.

Does your moving her out of the dungeon make her have the air elemental statue in her inventory?