Jump to content

[Help] Wrye Bash: BAIN wizard creation


IsharaMeradin

Recommended Posts

I have a mod (a couple actually) that I am slowly porting over to SSE.  The one currently in question is setup as a complex package that can be installed in WB.  I would, however, like to learn how to setup a wizard for WB so that users do not accidentally select a combination of options that are not intended to work together.  Is there a detailed set of instructions on creating a BAIN wizard?  By detailed I mean one that will stay on focus and not get me lost on tangents.  Or is there a GUI application which could be used to create a wizard by inputting the necessary data?  

If it helps, the installation primarily consists of selecting 1 out of 4 mesh options. Two of said options have an additional choice of 1 out of 3 texture options. The other 2 simply finish the installation.

Link to comment
Share on other sites

There is a helper in OBMM, but had trouble getting it to work (wrong game anyway)

Have you looked at the technical readme in Mopy/Docs/Wrye%20Bash%20Technical%20Readme.html?

The actual command layout in the installer follows along the lines of matching what a user would input in the RH GUI pane. Should be easy enough to edit in N++ or Sublime etc and give it a language flavour. Just involves a judicious use of SelectOne or SelectAny blocks. Alt3rnity is the best resource in that regard.

Here's an example wizard for COBL.

 

 

 

Link to comment
Share on other sites

The first port of call is the Wrye Bash documentation, Technical ReadMe

If you scroll down a bit you will start to see small examples

 

Next, the way most people learn is by examining other wizards as examples, and study the objectives of the mod to determine what files should have been installed per choice.

Though these are old and for Oblivion, if you throw the BAINs into Wrye Bash for Skyrim SE the wizard will still work as intended for the purpose of an example

AWLS

Metallicows Demo Wizard

And a few more from Skyrim I did

Kill the Orchestra

Alt Navetsea UNP Seamless

Those last two are also examples of being multi-installer friendly

The sub-packages have been made as a set of logical overwrites which is manual installation friendly, and aswell as having a Wrye Bash wizard in the root of the archive, they also have a FOMOd folder with relevant scripting for either NMM or MO ( which Wrye Bash will just ignore because it does not have anything in it you would expect to find in a complex sub-package )

 

Typically you will start with a Core Files sub-package, which has all files which are required for the installation

Then for options add more sub-packages

Good practice is to name them starting with numbers ( to order them as a series of overwrites in case the user select a bunch of them, then last installed out of the sub-packages wins - Just like the overall Installers Tab Install Order, sub-packages within BAINs also have an Install Order ) ..

 

00 Core files ( Includes plugin.esp | Textures \ *.* | Meshes \ *.* )

10 Textures HD ( All the main textures in HD which overwrites all the SD textures in Core files )

20 Meshes option 1 ( includes mesh replacer boots.nif with a custom texture path variation 1 for SD boots )

20 Meshes option 2 ( includes mesh replacer boots.nif with a custom texture path variation 2 for HD boots )

30 Boots Textures option 1 blue ( Textures \ IsharaMeradin \ custombluebootsSD.dds )

30 Boots Textures option 2 green ( Textures \ IsharaMeradin \ customgreenbootsHD.dds )

 

Note the two options start with 20 - Thats so if you are selecting sub-packages manually ( which people sometimes do instead of using your crafted wizard ) its obvious this is an either / or choice, only one of them should be selected

If the user were to tick both options, because of the package install order .. option 2 files would be installed ( assuming both options contain the same files, if the second option had less files than the first, then some files not replaced by the second option from the first option would still get installed )

 

Tip: The most common mistake with wizards, where there is a selectone or many, is how you end the block of choices

(Dont allow word wrap, makes this bit less confusing)

In the following wizard.txt, look at the line selectmany "Tick all skyrim music categories .. yada yada",\

it ends with ,\

and so do all the following lines in that choice block .. except the last one before the cases <-- Putting another ,\ there would make Wrye Bash go wibble. There are other common mistakes listed in the Technical Readme

( Click inside the following code box and use right / left cursor keys to scroll to end of line as required )

;== Kill The Orchestra - BaIn Wizard by Alt3rn1ty ==

RequireVersions "", "", "", "295"

DeSelectAll

DGYES = False
DBYES = False

If DataFileExists ("Dawnguard.esm")
    DGYES = True
EndIf
If DataFileExists ("Dragonborn.esm")
    DBYES = True
EndIf

;== WELCOME SCREEN ==

SelectOne "KILL THE ORCHESTRA SE - BAIN INSTALLATION WIZARD",\
  "|WELCOME","\nCLICK OPTIONS ABOVE TO REVIEW WHAT THIS INSTALLER INCLUDES OR ..\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "DESCRIPTION","\nKILL THE ORCHESTRA, SILENT SOUND FILES YOU INSTALL WHICH THE GAME WILL LOAD INSTEAD OF THE ORIGINAL MUSIC FILES. CHOOSE WHICH MUSIC TO DISABLE BY TYPE ( PERSONALLY I PREFER TO DISABLE EVERYTHING EXCEPT DISCOVER SPECIAL LOCATIONS ( IMPERIAL AND STORMCLOAKS CASTLES, HIGHHROTHGAR AND SOVNGARDE CHANTING ), REVEAL MUSIC ( AWESOME PLACES SUCH AS ELDERGLEAM SANCTUARY ), REWARD MUSIC ( RARE HIDDEN AREAS WHICH THIS MUSIC INDICATES YOU ARE IN THE VICINITY OF ), TAVERN MUSIC, AND THE TWO SPECIAL MUSIC OPTIONS FOR THE DLCS ).\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "VERSION","\nVERSION 3.2 ; INCLUDES OPTIONS FOR SKYRIM, DAWNGUARD AND DRAGONBORN MUSIC WHICH WILL AUTOMATICALLY BE OFFERED FOR INSTALLATION IF YOU HAVE THOSE DLC INSTALLED.\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "CREDITS","\nFLEEDAR FOR THE ORIGINAL IDEA - DISABLE MUSIC BY CATEGORY\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg"
EndSelect

;== SELECT SKYRIM MUSIC TO DISABLE ==

SelectMany "TICK ALL SKYRIM MUSIC CATEGORIES YOU WISH TO DISABLE",\
  "|Combat Music - Generic","\nDisable Combat Music - 11 music tracks silenced with this option.\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "|Combat Music - Bosses","\nDisable Boss Music - Music for Dragons and a few other Creatures and NPCs battles - 7 music tracks silenced with this option.\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "|Discover generic location","\nDisable Discover generic location Music - 3 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "Discover Special locations","\nDisable Imperial and Stormcloak Castle music, Highhrothgar and Sovngarde Chant music\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "|Discover Stinger music","\nDisable Stinger music - Short clip of music that can be used to introduce, end or link various sections - 4 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "|Dread Music","\nDisable Dread Music - The sudden big gong fading out sound typically in Draugr dungeons - 8 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "|Dungeon Music","\nDisable Dungeon Music - 10 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "|Explore Music","\nDisable Explore Music - 153 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "|Reveal Music","\nDisable Reveal Music - Rare or very special awesome looking locations typically a follower like Serana will make a comment on if they are accompanying you, for instance Eldergleam Sanctuary - 4 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "Reward Music","\nDisable Reward Music - Hidden areas or mini special quest locations which will only be indicated by this music playing, for instance there is a Thieves guild ancient armour location will trigger one of these sounds - 4 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "Tavern Music","\nDisable Tavern Music - 5 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "|Town Music","\nDisable Town Music - 7 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
  "|Word Wall Music","\nDisable Word Wall Music - Music which plays once you absorb the knowledge - 3 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg"
  Case "Combat Music - Generic"
    SelectSubPackage "05 Skyrim - Combat Music - Generic"
    Break
  Case "Combat Music - Bosses"
    SelectSubPackage "10 Skyrim - Combat Music - Bosses"
    Break
  Case "Discover generic location"
    SelectSubPackage "15 Skyrim - Discover generic location"
    Break
  Case "Discover Special locations"
    SelectSubPackage "20 Skyrim - Discover Special locations"
    Break
  Case "Discover Stinger music"
    SelectSubPackage "22 Skyrim - Discover Stinger music"
    Break
  Case "Dread Music"
    SelectSubPackage "25 Skyrim - Dread Music"
    Break
  Case "Dungeon Music"
    SelectSubPackage "30 Skyrim - Dungeon Music"
    Break
  Case "Explore Music"
    SelectSubPackage "35 Skyrim - Explore Music"
    Break
  Case "Reveal Music"
    SelectSubPackage "40 Skyrim - Reveal Music"
    Break
  Case "Reward Music"
    SelectSubPackage "45 Skyrim - Reward Music"
    Break
  Case "Tavern Music"
    SelectSubPackage "50 Skyrim - Tavern Music"
    Break
  Case "Town Music"
    SelectSubPackage "55 Skyrim - Town Music"
    Break
  Case "Word Wall Music"
    SelectSubPackage "58 Skyrim - Word Wall"
    Break
EndSelect

;== SELECT DAWNGUARD MUSIC TO DISABLE IF INSTALLED ==

If DGYES
  SelectMany "TICK ALL DAWNGUARD MUSIC CATEGORIES YOU WISH TO DISABLE",\
    "|Soulcairn Dungeon","\nDisable Soulcairn Dungeon Music - 1 music track silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
    "|Soulcairn Explore","\nDisable Soulcairn Explore Music - 8 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
    "|Falmervalley Explore","\nDisable Falmervalley Explore Music - 1 music track silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
    "|Vampirecastle Dungeon","\nDisable Vampirecastle Dungeon Music - 2 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
    "Special - Eclipse","\nDisable Special Eclipse Music - 1 music track silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg"
    Case "Soulcairn Dungeon"
      SelectSubPackage "60 Dawnguard - Soulcairn Dungeon"
      Break
    Case "Soulcairn Explore"
      SelectSubPackage "65 Dawnguard - Soulcairn Explore"
      Break
    Case "Falmervalley Explore"
      SelectSubPackage "70 Dawnguard - Falmervalley Explore"
      Break
    Case "Vampirecastle Dungeon"
      SelectSubPackage "75 Dawnguard - Vampirecastle Dungeon"
      Break
    Case "Special - Eclipse"
      SelectSubPackage "80 Dawnguard - Special - Eclipse"
      Break
  EndSelect
EndIf

;== SELECT DRAGONBORN MUSIC TO DISABLE IF INSTALLED ==

If DBYES
  SelectMany "TICK ALL DRAGONBORN MUSIC CATEGORIES YOU WISH TO DISABLE",\
    "|Explore","\nDisable Explore Music - 11 music track silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
    "|Apocrypha","\nDisable Apocrypha Music - 2 music tracks silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg",\
    "Special - BoatArrival","\nDisable Special BoatArrival Music - 1 music track silenced with this option\n\nCLICK NEXT TO CONTINUE THE INSTALLATION","FOMod\\screenshot.jpg"
    Case "Explore"
      SelectSubPackage "85 Dragonborn - Explore"
      Break
    Case "Apocrypha"
      SelectSubPackage "90 Dragonborn - Apocrypha"
      Break
    Case "Special - BoatArrival"
      SelectSubPackage "95 Dragonborn - Special - BoatArrival"
      Break
  EndSelect
EndIf

;== Finish Page ==

Note "\nCHECK SELECTION ABOVE, IF NOT HAPPY USE THE BACK BUTTON .. WHEN READY, TICK 'APPLY THESE SELECTIONS' BELOW, AND THEN FINISH.\n\nIF YOU HAVE AUTO-ANNEAL/INSTALL WIZARDS SET IN WRYE BASH INSTALLER PREFERENCES .. THE WIZARD WILL INSTALL YOUR SELECTIONS AFTER CLICKING FINISH - OTHERWISE, RIGHT CLICK THE INSTALLER AGAIN AND CHOOSE INSTALL"

 

Also note the | character at the start of some option description titles, that indicates to Wrye Bash to auto select that option by default

( Its usually the \ key shifted )

 

Note on Sub-package Install Order - Wrye Bash installs them in Numerical/Alpha order

So where two subpackages start with the same number, then the rest of the sub-package name ( alphabetical order ) determines the order

00 Core A\ *.*

00 Core B\ *.*

Select both, and B's files win where there are conflicts between the two.

gallery_1652_58_296915.jpg

gallery_1652_58_133398.jpg

Link to comment
Share on other sites

Thanks for the information. I may try to get a working wizard going. However, I decided that I'm going to put off porting this mod.  It is a body mesh mod with underwear options.  With the neck seam issue and not knowing where it is coming from, I don't want to release meshes that might be incorrect.  So until such time as the neck seam / lighter head issue is resolved, this project is on the back burner.

If you happen to have heard of a resolution already, please feel free to share.

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
×
×
  • Create New...