Bug report/feature request format suggestions

[jcompton]

I think I'm still the world's leading reporter of WeiDU bugs and requester of WeiDU features but I'm certainly not the ONLY one anymore, so I thought I'd share these handy hints and tips to make your efforts to push WeiDU towards version 1000 happy and speedy.

Bug Reporting
Many, I'd go so far as to say most, bugs in WeiDU are a result of trying to do something that Wes has never tried to do in one of his mods--otherwise, he'd notice it wasn't working. So provide the exact code that isn't working.

A bad bug report goes like this:

"ADD_FLINGLE doesn't work, it always crashes my TP2."

A better bug report goes like this:

"ADD_FLINGLE was working until version 372. I didn't change any code, but now the install process dies. Here's the portion of the TP2 and the portion of the DEBUG file that shows what's going on"

insert TP2 and DEBUG code here.


Feature Requesting

Much like bug reporting, if a feature doesn't exist in WeiDU, it's probably because nobody, Wes in particular, has thought of needing it or how it would work or what it would do. Try to describe not only what you want it but how it would operate (and some "why you want it" will help as well, since Wes often requires feature requests to be seconded and thirded, and if you explain it to other people they'll find it easier to chime in.)

Be explicit. Be detailed. If you think you're coming off as a bit pedantic, that's probably the right level of detail.

So, a bad feature request goes like

"I want a feature to add a state where we eat toast to the end of any dialogue."

A better feature request goes like

"I am working on a mod where eating toast is very important to the characters, but I don't want to constantly have to keep coming back to the same piece of toast, so at the top of the .d I want to SET_TOAST_ITEMS and provide a list of .itms that represent toast in various states of toastedness and butteredness, then I want a function that does EAT_TOAST_ITEM as a state transition, so will give a random piece of toast to Player1.

It would look something like this:

(example.)"

- Again, be detailed. If something's broken, show what it is.

- If something used to work but stopped working, be explicit about that, including which versions it works with and when it stopped.

- If you report your version of DirectX, we'll giggle.
                   

[AngeMusicien]

The extern function for BG2EE kits, fl#add_kit_ee, waits for a "briefidesc" arguments.

But in the readme and the examples, it's "briefdesc". Which is more logical. Looks like a typo in the programm.


(by the way please change this visual verification. I will kill something in the next 3 minutes if I fail it another time  )

[Jondalar]

Hi,

I think I found a bug in WeiDU v 23800. The problem is related to the special characters used in Spanish (accents, ñ, ¿ and ¡ I guess, maybe there are other characters I don't know). Mods install with no errors but when you are playing and the game needs to read a sentence with those characters it freezes, and then after a while crashes.

I first found this a couple of days ago trying to install the mod "dungeon be gone", I solved the problem installing the mod in English and assumed it was a problem with that mod. However, today I had the same problem with a mod I am doing so I understand this is a problem more broad and related to weidu itself.

Thanks for your help!

[Wisp]

Hi,

I think I found a bug in WeiDU v 23800. The problem is related to the special characters used in Spanish (accents, ñ, ¿ and ¡ I guess, maybe there are other characters I don't know). Mods install with no errors but when you are playing and the game needs to read a sentence with those characters it freezes, and then after a while crashes.

I first found this a couple of days ago trying to install the mod "dungeon be gone", I solved the problem installing the mod in English and assumed it was a problem with that mod. However, today I had the same problem with a mod I am doing so I understand this is a problem more broad and related to weidu itself.

Thanks for your help!

That's not a WeiDU problem. It sounds like you are installing an incompatible mod on an EE game. The mod text needs to be in UTF-8 or you get issues like yours.

[nullset]

Since Windows 10 updated to the Anniversary Edition, WeiDU fails trying to set up the BACKUP directories. I was using WeiDU v239, but the problem occurs for versions 236 thru 240. No debug log is produced. My tp2 is:


BACKUP ~Rjali/Backup~

AUTHOR ~nullset@sympatico.ca~

// Here's where we make NPC dialogues to do CHAIN dialogue for non-existent NPC !InParty

ALLOW_MISSING ~O#BRANJ.dlg~
              ~O#BRA25J.dlg~
              ~O#BBRAN.dlg~
              ~O#BBRA25.dlg~
              ~SAERILEJ.dlg~
              ~SAERI25J.dlg~
              ~BSAERILE.dlg~
              ~BSAERI25.dlg~
              ~TASHIAJ.dlg~
              ~TASHI25J.dlg~
              ~BTASHIA.dlg~
              ~BTASHI25.dlg~
              ~LK#NINDJ.dlg~
              ~LK#NI25J.dlg~
              ~BLK#NIND.dlg~
              ~BLK#NI25.dlg~
              ~G#TYRISJ.dlg~
              ~G#TRS25J.dlg~
              ~BG#TYRIS.dlg~
              ~BG#TRS25.dlg~
              ~YxYveJ.dlg~
              ~YxYv25J.dlg~
              ~YxYveB.dlg~
              ~YxYv25B.dlg~
              ~E3FADEJ.dlg~
              ~E3FAD25J.dlg~
              ~BE3FADE.dlg~
              ~BE3FAD25.dlg~
              ~RH#ISRJ.dlg~
              ~RH#IS25J.dlg~
              ~BRH#ISR.dlg~
              ~BRH#IS25.dlg~
              ~T#DACEJ.dlg~
              ~T#DAC25J.dlg~
              ~BT#DACE.dlg~
              ~BT#DAC25.dlg~
              ~M#AMBERJ.dlg~
              ~M#AMB25J.dlg~
              ~BM#AMBER.dlg~
              ~BM#AMB25.dlg~
              ~NEERAJ.dlg~
              ~NEERA25J.dlg~
              ~BNEERA.dlg~
              ~BNEERA25.dlg~
              ~1XSKIEJ.dlg~
              ~1XSKI25J.dlg~
              ~1XSKIEB.dlg~
              ~1XSKI25B.dlg~
              ~L3PETSYJ.dlg~
              ~L3PET25J.dlg~
              ~L3PETSYB.dlg~
              ~L3PET25B.dlg~

VERSION ~v7.1~

README ~Rjali/Readme-Rjali.txt~

AUTO_TRA ~Rjali/Languages/%s~
LANGUAGE ~English~ ~English~ ~Rjali/Languages/English/setup.tra~

// Here's where we set experienced players' talk time adjustments

BEGIN @54
SUBCOMPONENT @57

  COPY ~Rjali\bantergoose\bantergoose.xxx~ ~override\rjspeed1.xxx~

BEGIN @55
SUBCOMPONENT @57

  COPY ~Rjali\bantergoose\bantergoose.xxx~ ~override\rjspeed2.xxx~

BEGIN @56
SUBCOMPONENT @57

  COPY ~Rjali\bantergoose\bantergoose.xxx~ ~override\rjspeed3.xxx~

// This is the main event

BEGIN @500
REQUIRE_PREDICATE GAME_IS ~BG2EE~ @51
REQUIRE_PREDICATE FILE_EXISTS_IN_GAME ~mel01.cre~ @52

// Set mod defaults

INCLUDE ~Rjali/tpa/default.tpa~

// Here's where we fix bugs and patch mods

INCLUDE ~Rjali/tpa/bugs_patches.tpa~

// PST Animations

INCLUDE ~Rjali/tpa/animations.tpa~

// Rjali's sound sets

LAF HANDLE_AUDIO END

// Rjali's portraits

INCLUDE ~Rjali/tpa/portraits.tpa~

// Areas

INCLUDE ~Rjali/tpa/areas.tpa~

// Area music

INCLUDE ~Rjali/tpa/music.tpa~

// Here's where we put creatures

INCLUDE ~Rjali/tpa/creatures.tpa~

// Here's where we put items

INCLUDE ~Rjali/tpa/items.tpa~

// Here's where we put spells

COPY ~Rjali\Spells~ ~override~

// These are the main dialogues and scripts for SoA and ToB

INCLUDE ~Rjali/tpa/main.tpa~

// Here's where we park NPCs back in the deArnise Keep

INCLUDE ~Rjali/tpa/park.tpa~

// Here's where we put PST scripts and dialogues

INCLUDE ~Rjali/tpa/pst.tpa~

// This is to maintain a roster of dummy cre's to reduce CHAIN dialogue logic.

INCLUDE ~Rjali/tpa/roster.tpa~

// Here's where we put the stuff for the Djinn of the lamp

COMPILE ~Rjali/Dialogue/SOA/RJGENIE.d~
        ~Rjali/Scripts/SOA/RJGENIE.baf~
        ~Rjali/Scripts/SOA/CUTSCENES~    // Tourist cutscenes

// Dialogues of the Orphanage Project.

COMPILE ~Rjali/Dialogue/TOB/RJOrphans.d~

// Since we want our NPCs to have epilogues, we'll add them to the last area in the game:

INCLUDE ~Rjali/tpa/epilogues.tpa~

// Here's where we put Rjali's multiple romance facilities

INCLUDE ~Rjali/tpa/multi.tpa~

// Here's where we put joinable NPC pdialog.2da and interdia.2da

INCLUDE ~Rjali/tpa/npc2da.tpa~

// Flirts - must be last thing in dialogue files

INCLUDE ~Rjali/tpa/flirts.tpa~

// Here's where we adjust talk times for faster play

ACTION_IF MOD_IS_INSTALLED ~Rjali/setup-Rjali.tp2~ "0" OR
          MOD_IS_INSTALLED ~Rjali/setup-Rjali.tp2~ "1" OR
          MOD_IS_INSTALLED ~Rjali/setup-Rjali.tp2~ "2" THEN BEGIN

INCLUDE ~Rjali/tpa/expedite.tpa~

END

ACTION_IF MOD_IS_INSTALLED ~Rjali/setup-Rjali.tp2~ "1" OR
          MOD_IS_INSTALLED ~Rjali/setup-Rjali.tp2~ "2" THEN BEGIN

INCLUDE ~Rjali/tpa/speed.tpa~

END

// Here's where Rjali equips party members

BEGIN @50
REQUIRE_COMPONENT "Rjali/setup-Rjali.tp2" "3" @65

INCLUDE ~Rjali/tpa/equip.tpa~

The DOS window has the following:

[D:\Games\Beamdog\Games\00783\Setup-Rjali.exe] WeiDU version 23900
WARNING: unable to open log file [SETUP-RJALI.DEBUG]: Sys_error("SETUP-RJALI.DEBUG: Permission denied")[.\chitin.key] 187 BIFFs, 62160 resources
[.\lang\en_us\dialog.tlk] 131396 string entries
Using Language [English]
[English] has 1 top-level TRA files
[Rjali/Languages/English/setup.tra] has 343 translation strings

Using .\lang\en_us\dialog.tlk

Would you like to display the readme? [Y]es [N]o
n
[.\DATA\AREAS.BIF] 2545324 bytes, 318 files, 0 tilesets
RJPREFIX/SETUP-RJPREFIX.TP2  0  0 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 20 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 130 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 1080 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 1160 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 1170 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2060 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2090 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2100 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2120 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2151 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2200 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2210 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2352 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2360 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 2380 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3000 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3012 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3020 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3031 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3040 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3050 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3080 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3090 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3100 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3110 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3120 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3123 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3150 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3170 Installed
BG2_TWEAKS/SETUP-BG2_TWEAKS.TP2  0 3183 Installed
SETUP-SEMI_MULTI_CLERICS.TP2  0  0 Installed
SETUP-NPCFLIRT.TP2  0  0 Installed
SETUP-NPCFLIRT.TP2  0  2 Installed
SETUP-NPCFLIRT.TP2  0  4 Installed
SETUP-NPCFLIRT.TP2  0  6 Installed
SETUP-NPCFLIRT.TP2  0  8 Installed
SETUP-NPCFLIRT.TP2  0 10 Installed
SETUP-NPCFLIRT.TP2  0 16 Installed
SETUP-NPCFLIRT.TP2  0 17 Installed
IMOENROMANCE/SETUP-IMOENROMANCE.TP2  0  0 Installed
IMOENROMANCE/SETUP-IMOENROMANCE.TP2  0  1 Installed
BRANWEN/SETUP-BRANWEN.TP2  0  0 Installed
DEARNISE/SETUP-DEARNISE.TP2  0  0 Installed
SAERILETH/SETUP-SAERILETH.TP2  0  0 Installed
FADE/SETUP-FADE.TP2  0  0 Installed
ETERNALIMOEN/SETUP-ETERNALIMOEN.TP2  0  0 Installed
ETERNALIMOEN/SETUP-ETERNALIMOEN.TP2  0  1 Installed
RJPOSTFIX/SETUP-RJPOSTFIX.TP2  0  0 Installed

Install Component [Bantergoose and Parking Expedite]?
[N]o, [Q]uit or choose one:
 1] No Other Mod Timing Adjustments
 2] Mod Timing A Little Faster
 3] Mod Timing A Lot Faster
3
Uninstalling All Other Subcomponents of [Bantergoose and Parking Expedite]
Done Uninstalling All Other Subcomponents of [Bantergoose and Parking Expedite]
Problem Unix.Unix_error(1, "mkdir", "Rjali") on Rjali: util.ml
Problem Unix.Unix_error(1, "mkdir", "Rjali/Backup") on Rjali/Backup: util.ml
Problem Unix.Unix_error(1, "mkdir", "Rjali/Backup/2") on Rjali/Backup/2: util.ml
WARNING: unable to open [Rjali/Backup/2/UNINSTALL.2]: Sys_error("Rjali/Backup/2/UNINSTALL.2: Permission denied")
      Will be unable to UNINSTALL later.
ERROR: Sys_error("Rjali/Backup/2/ARGS.2: Permission denied")
Using Language [English]
[English] has 1 top-level TRA files
[Rjali/Languages/English/setup.tra] has 343 translation strings

Install Component [Bantergoose and Parking Expedite]?
[N]o, [Q]uit or choose one:
 1] No Other Mod Timing Adjustments
 2] Mod Timing A Little Faster
 3] Mod Timing A Lot Faster

[nullset]

It is definitely an artifact of the Windows 10 Anniversary Edition update. I have rolled back my opsys to before that update (and turned off Windows Update), and everything is back and working. It also rendered my NWN unplayable in roughly the same manner as WeiDU was affected. DEFENESTRATE BILL GATES!!!