[REL] BAIN Project Tools : IV

» Wed Sep 01, 2010 12:57 pm

BAIN Project Tools (BAT)
Download from http://www.tesnexus.com/downloads/file.php?id=34271.

Introduction

BAIN Project Tools (BAT) is an aid to manipulating and naming existing Complex BAIN projects. BAT operates at the sub-package level and provides tools to…

Manage and manipulate sub-package numbering
Help make sub-package names easy to change
Append a suffix to sub-package names (useful to highlight which ones you selected in Wrye Bash)
Insert "separator" sub-packages to use as headings
Automatically create separate sub-packages for each ESP that is in a single BAIN sub-package
Produce a list of your BAIN Project structure (sub-packages) for posting on forums
View all changes before applying them

I am a keen constructer of complex BAIN projects to reduce the number of archives I manage. I wrote BAT to help me do this more easily and more quickly and find it a useful aid for my personal projects. I have released BAT in case anyone else benefits from using it.

See http://www.tesnexus.com/downloads/readmes/BAIN%20Project%20Tools_readme.txt for more information about changes made since the initial release.

Required

Microsoft Word 2010, 2007 or 2003
- It may work on earlier versions, but I am unable to test this

http://www.tesnexus.com/downloads/file.php?id=22368
- BAT is of no use unless you are using Wrye Bash to install BAIN archives

Sample Output
To create a BAIN version of Better Cities that was more to my taste took about 10 minutes using BAT...

Spoiler

Better Cities v4.6.1c
000 Core [ON]
010 =================== Separate Cities
010 ANVIL
011 BRAVIL
011 BRAVIL - Blood and Mud
012 BRUMA
013 CHEYDINHAL
014 CHORROL
015 LEYAWIIN
016 SKINGRAD
030 =================== Separate Imperial City Districts
030 Arboretum
031 Arcane University
032 Arena
033 Elven Gardens
034 Green Emperor Way
035 Market
036 Prison
037 Talos Plaza
038 Temple
039 Waterfront
050 =================== Unified
050 Better Cities Full - Blood and Mud Edition
050 Better Cities Full [ON]
052 Better Imperial City [ON]
100 =================== Options
100 Leyawiin Flood Removal
101 View When Distant IC
200 =================== Replacers
200 Against the Zealots of the Nine
201 Clocks of Cyrodiil
202 Mystery of the Dulan Cult
203 Scribe Supplies - Intensive
203 Scribe Supplies - Read summary
204 Slofs Goth Shop
205 Vaults Of Cyrodiil
300 =================== Patches
300 Brew House
301 Cobl
302 Dwemer Subway
303 Halcyon Island
304 Knightly Armory
305 Oblivion Collectible Cards
306 Old Crow Inn
307 Ruined Tail's Tale
308 sixlivion
309 Tears of the Fiend
310 Thievery in the Imperial City
311 TIE
312 Trails Of Cyrodiil
316 Valley View Estate
317 Verona House Bloodlines
350 =================== Patches - Unique Landscapes
350 Bravil Barrowfields
350 Bravil Barrowfields - Blood and Mud
350 Bravil Barrowfields - Full Blood and Mud
350 Bravil Barrowfields - Full [ON]
351 Cheydinhal Falls
351 Cheydinhal Falls - Full Blood and Mud
351 Cheydinhal Falls - Full [ON]
352 Chorrol Hinterlands [ON]
353 Skingrad Outskirts [ON]
360 =================== Patches - CUO
360 Bravil
360 Bravil - Blood and Mud
360 Bravil - Full
360 Bravil - Full Blood and Mud
361 Chorrol
361 Chorrol - Full
361 Chorrol - Full Blood and Mud
362 Leyawiin
362 Leyawiin - Full
362 Leyawiin - Full Blood and Mud
363 Origin of the Mage's Guild - Better Cities
363 Origin of the Mage's Guild - Better Imperial City
400 =================== FPS Patches - Separate Cities
400 Anvil
401 Bravil
401 Bravil - Blood and Mud
402 Bruma
403 Cheydinhal
404 Chorrol
405 Leyawiin
406 Skingrad
420 =================== FPS Patches - Separate Imperial City Districts
420 Arboretum
421 Arcane University
422 Elven Gardens
423 Market
424 Prison
425 Talos Plaza
426 Temple
427 Tunnel
428 Waterfront
450 =================== FPS Patches - Unified
450 Better Cities Full
450 Better Cities Full - Blood and Mud Edition
451 Better Imperial City

Credits and Thanks

My thanks to the Wrye Bash project team for creating and maintaining this invaluable tool.

Licensing and Legal

You may not use the BAIN Project Tools for commercial purposes
You may not upload the BAIN Project Tools without the express permission of Surazal
You may change and publish something based on the BAIN Project Tools providing it does not contravene #1. Giving me credit would be nice.

_______________________________________________________________________________
http://www.tesnexus.com/modules/members/index.php?id=339693

» Wed Sep 01, 2010 11:49 am

wow! with graphic interface too?

Will be getting this and trying it out soon - thanks!

» Wed Sep 01, 2010 5:56 pm

wow! with graphic interface too?

Will be getting this and trying it out soon - thanks!

Hi Psymon

I hoped that this might interest you - hope you enjoy playing around with it and interested to know if you find it of any use.

» Wed Sep 01, 2010 10:27 pm

I'm already completely lost on installing this with Office 2007.

The instructions don't seem to cover that - what 'options' ... do you mean in Word or somewhere on the operating system? Since I already have the developer tab active in Office 2007 I just went to security there and it looks like the same options but look much different than the instructions. then it gave rather stern warnings, so I may look into risks that could happen if I activate these things. Like if I do so then open a doc with these controls that I'm not aware has them - I think I want prompts.

» Thu Sep 02, 2010 12:51 am

I'm already completely lost on installing this with Office 2007.

The instructions don't seem to cover that - what 'options' ... do you mean in Word or somewhere on the operating system? Since I already have the developer tab active in Office 2007 I just went to security there and it looks like the same options but look much different than the instructions. then it gave rather stern warnings, so I may look into risks that could happen if I activate these things. Like if I do so then open a doc with these controls that I'm not aware has them - I think I want prompts.

Do the messages described in the BAT Installer documentation under "Installing with Word Version 2007" match what you are seeing?
If so, what prompts do you need?
If not, what do you see that is different?

In essence, the Macro security warnings are all about truusting the source of the document. On the assumption that you trust what I have produced, you can enable the Macros to allow the Installer to run. Once it has finished, you can restore your original security settings - the BAT document will not need you to change them.

Does this help?

Edit: For Word 2007, you security settings are only changed when you open this document. If you close the document and open it again, you will get the same security warning - ie it is a temporary enable of the macros in the Installer document.

» Wed Sep 01, 2010 4:18 pm

It says click 'options' - OK where is this options to click?

» Wed Sep 01, 2010 12:54 pm

Hi Psymon

I hoped that this might interest you - hope you enjoy playing around with it and interested to know if you find it of any use.

He is not only one to be interested in your new tool Surazal and was I excited when I saw it on Nexus so I already have it, but I've a question though.

It's possible to install this tool working together when you have the http://www.openoffice.org/ installed?

Thanks for your work on this Surazal. :clap: :celebration:

» Wed Sep 01, 2010 10:30 pm

It says click 'options' - OK where is this options to click?

If you don't see the security banner with Options, it should mean that the macro is enbaled and you can Click the Install BAT button to launch the Installer - let me know if that is working.

He is not only one to be interested in your new tool Surazal and was I excited when I saw it on Nexus so I already have it, but I've a question though.

It's possible to install this tool working together when you have the http://www.openoffice.org/ installed?

Thanks for your work on this Surazal. :clap: :celebration:

You can run MS Word and Open Office together, but BAT will only work with MS Word.

Have I understood the question correctly?

» Wed Sep 01, 2010 11:15 am

If you don't see the security banner with Options, it should mean that the macro is enbaled and you can Click the Install BAT button to launch the Installer - let me know if that is working.

Ahh I found the banner - I was looking for a splash screen. What it wasn't obviously.

And then I guess copying out the product to a folder I use more often (near the actual projects) seems to work.

Amazing that you are getting what looks like a slick graphic user interface from word macros.

I have errands to run right now but will report back later when I do my weekly updates and such.

thanks!

» Wed Sep 01, 2010 8:15 pm

Ahh I found the banner - I was looking for a splash screen. What it wasn't obviously.

And then I guess copying out the product to a folder I use more often (near the actual projects) seems to work.

Amazing that you are getting what looks like a slick graphic user interface from word macros.

I have errands to run right now but will report back later when I do my weekly updates and such.

thanks!

Glad you got it working.

Remember that you can try all the tools out and as long as you DON'T press the Apply Changes button, nothing will be altered on your disk - so do feel comfortable with just doing anything to see what happens

Look forward to your feedback

» Wed Sep 01, 2010 3:42 pm

If you don't see the security banner with Options, it should mean that the macro is enbaled and you can Click the Install BAT button to launch the Installer - let me know if that is working.

You can run MS Word and Open Office together, but BAT will only work with MS Word.

Have I understood the question correctly?

Yes you did, but the OpenOffice.org Writer is 100% compatible with MS Word. I'm could be wrong though.

» Wed Sep 01, 2010 10:03 pm

Aaah, another tool that looks promising - am a big fan of your projects Surazal!

I was able to install this without problems. So how does one go about using this?

Is the Projects folder supposed to be the BASH Installers folder? And what can I do with this tool - as in, I take an existing 7z file (which is a BAIN-raeady archive), and manipulatet he sub-headings and files in it?

» Wed Sep 01, 2010 10:06 pm

So usually when I work with packaging projects I keep an extra folder in the package with a leading ___ that usually has the source archives.

So as an example here is the BAIN folder for StarX:

Directory path/.../StarX Vampires-BAIN   │   ├[10 StarX Vampires Revised]   ├[15 FCOM-OOO patch]   ├[20 SVVR Optional Files]   ├[21 blue eyes]   ├[21 Eyes Salems Lot]   ├[21 white eyes]   ├[21 yellow eyes]   ├[30 Serentin Vampire Armors]   ├[35 StarX WitchHunter Armor]   ├[36 WitchHunter HGEC c-cup]   ├[40 StarX Vampire Deaths Improved]   ├[50 SVVR meets OVB patch]   └[___Source]

I just find it easier to keep the original archives near (in) the package folder. Mainly because then opening 7zip it is just a few changes in levels to get from the original package to what I'm repacking. Anyway is it possible this leading ___ is causing this error:

' ==============================================================================================
' GetNum: Returns the Sub-Package number from the folder name
' ==============================================================================================

Function GetNum(fSubPackage As String) As String
GetNum = Left(fSubPackage, InStr(1, fSubPackage, " ") - 1) <----
End Function

Run time error 5 it says.

[edit] actually that must be it as removing the '___source' folder stopped that. With that error though - no going forward.

Ok that was the first thing - forging onward.

===========

next - just having it open an empty folder ... such as 'Dynamic Weather-BAIN' as the active project then it will give run time error 9 and will not open - it will if there are already folders in there though. Well I had a 'docs' folder in there and got runtime 5 again. So it seems to like having only numbered folders.

Needs more of a readme ... maybe starting with what one should keep as the default locales of the project folders and active folders (both seem arbitrary and transient) - why not just one target folder setting?

» Wed Sep 01, 2010 11:42 pm

Yes you did, but the OpenOffice.org Writer is 100% compatible with MS Word. I'm could be wrong though.

I would be suprised if it worked with Writer - but do let me know if it works.

» Wed Sep 01, 2010 9:38 am

Aaah, another tool that looks promising - am a big fan of your projects Surazal!

I was able to install this without problems. So how does one go about using this?

Is the Projects folder supposed to be the BASH Installers folder? And what can I do with this tool - as in, I take an existing 7z file (which is a BAIN-raeady archive), and manipulatet he sub-headings and files in it?

It does not work with archives - only projects (ie youhave to extract the contents of the archive to a folder so you can work on it - once you have finished, you would create the arcgive for use in WB.

So usually when I work with packaging projects I keep an extra folder in the package with a leading ___ that usually has the source archives.

So as an example here is the BAIN folder for StarX:

[edit] actually that must be it as removing the '___source' folder stopped that. With that error though - no going forward.

next - just having it open an empty folder ... such as 'Dynamic Weather-BAIN' as the active project then it will give run time error 9 and will not open - it will if there are already folders in there though. Well I had a 'docs' folder in there and got runtime 5 again. So it seems to like having only numbered folders.

Needs more of a readme ... maybe starting with what one should keep as the default locales of the project folders and active folders (both seem arbitrary and transient) - why not just one target folder setting?

I knew there was an area of testing I had wanted to do and could not remember what it was so I released the utility - and you of course have reminded me. I will do some testing and correct these issues so it works when there are non-numbered folders in your project.

Resolving the Bugs will be my first priority - they happened because I keep my BAIN Project docs and original archives in a seperate folder from my projects - so on my system, BAIN projects only contain what will be installed (and I don't use WB for managing the docs). Will release something as soon as I have fixed these isues.

Many thanks for the feedback - it always helps to see what happens when other people get hold of stuff I am using

On the readme, not quite sure what you mean about the default locale of project and active folders. My understanding is that BAIN projects are the extracted contents of a BAIN archive. In BAT terms, the Active Project is the one you have open. So I have a folder called Wrye Bash Build Area that contains the extracted versions of all my BAIN archives. The default on WB, is to extract the BAIN archive to BASH Installers folder so, by default, the Projects folder is the same as the Bash Installers folder.

» Wed Sep 01, 2010 9:04 pm

BAIN Project Tools (BAT) v1.0.1 Released

This release fixes a significant oversight on sub-package validation (thanks Psymon).

New Features

BAT will "remember" your screen position between sessions.

Fixes
BAT now handles other folder types in a BAIN project without crashing
Minor fix to include Projects Path checking before allowing an Active Project to be selected

Help Documentation Changes
Added a note to highlight that BAT only handles numerically numbered sib-packages in BAIN project - Alphabetic ones are ignored.

» Thu Sep 02, 2010 12:07 am

I would be suprised if it worked with Writer - but do let me know if it works.

@Word Wizard

It does not!

Open Office's compatibility ends here.

Crash

I almost forgot, Thank you for another great tool.

» Wed Sep 01, 2010 9:57 am

So then is this just a way of crafting BAIN packages?

What is it's main function? While I cna get it to recognize and renumber sub-packages on an exiting folder/project - it does not seem able to add packages. Where is the button to add sub-packages?

Then it does recognize loose files either, so I take it that all it does in manipulate folder structure and naming.

That is what I mean by readme - I'm not seeing the point of this yet.

» Wed Sep 01, 2010 11:23 am

so I take it that all it does in manipulate folder structure and naming.

That is exactly what it is for. You stil have to start with BAIN project.

I will revise the opening statement of the documentation and use your phrase.

» Wed Sep 01, 2010 7:33 pm

How does one insert/create a sub-package?

If it can do that then yeah I'd see value in it.

Made a shortcut on desktop and if I can create folders after the first main one then I'd probably use it.

» Wed Sep 01, 2010 5:16 pm

BAIN Project Tools (BAT) v1.0.2 Released

This should be the final set of changes associated with doing an initial release - there are always things that seem to crop up straight after I publish anything

As always, I am open to suggestions and welcome any feedback.

New Features

None.

Fixes
Corrected a sub-package selection problem that occurs when switching between Naming and Numbering tools without any sub-packages selected
Installer: Now migrates your BAT screen position correctly.

Help Documentation Changes
A few subtle changes to the documentation to try and clarify BAT's purpose.

» Wed Sep 01, 2010 12:21 pm

How does one insert/create a sub-package?

If it can do that then yeah I'd see value in it.

Made a shortcut on desktop and if I can create folders after the first main one then I'd probably use it.

How would you like to see this work?

Should it create an empty folder with the next number available?
Should it be copying any files to the new folder?
etc

Guidance as to what you would find useful, will help me think about how I can implement such a feature.

Thanks for the feedback

» Wed Sep 01, 2010 8:57 pm

Well wait - I'm just trying to figure out how it works.

So as it is now it only re-names or numbers existing folders?

I see the lower left has naming tools, but can't figure out how to get them to be un-gray and active. I seem to be able to renumber existing folders and then that is it. Can't seem to rename any or create any.

Well I guess if you are open to suggestions and this is able to be implemented .. why not have it so there is an option to create a certain number of folders (maybe within a range in a box). Maybe also an option to create one folder at a time (so it could be spammed). Then the next set of options being the numbered sequences (the current right hand middle panel area).

Then maybe the bottom right being the naming - which could or could not be extensions to the numbered folders above.

Maybe an option to insert a docs folder in each folder.

But then all these features - maybe they are there - I just can't figure out how to do anything more than renumber existing folders, so don't think I'm being critical of what is there as I've not seen it in action.

[edit] Oh wait - the button that said 'activate naming tools' looked like a window - didn't realize that was a button.
Hmm - OK so then yeah - need to explore this more now - one can number then name - that is cool.

Will think more about it.

[edit 2]
also the lack of having a watchamacallit tab at the bottom windows bar (bottom of desktop) so that you can see it is open (if several programs are open) is kinda frustrating. Couple times didn't realize it was still open.

» Wed Sep 01, 2010 5:32 pm

[edit] Oh wait - the button that said 'activate naming tools' looked like a window - didn't realize that was a button.
Hmm - OK so then yeah - need to explore this more now - one can number then name - that is cool.

Will think more about it.

Btw, you can also Right-Click on the list to switch between the Number and Naming tools (do use the latest version which corrects an anomaly with this).

I will wait to see what you come up with before diving in and making any changes (although the Docs sub-folder creation would be an easy change to make).

Basically, I kept adding tools when I wanted to do things on my BAIN projects...
- like sorting the sub-packages in my Sensual Walks mod so that they were listed in alphabetic order rather than in add order
- like inserting the "separator" folder with a dummy ESP to make it easier to read in WB
- like taking a folder with a number of ESPs and creating a sub-package for each - don't like using WB's ESP filter
- like wanting to change the numbering system after gaining handsight
- etc

Edit:
Re your Edit 2: This is function of hiding the Word interface to make BAT run faster and avoid clutter - the downside is the one you described. On my system I keep the BAT window on the right-hand side of my screen, so I can usually see it. I will have a think about this to see if there is a compromise solution.

» Wed Sep 01, 2010 6:15 pm

Well it is bedtime here for bonzo. Brain fried after all the Fallout updates and finally finishing blood and mud (kind of a let down actually).

So yeah I'd think it cool to be able to have two buttons - one with a window next to it where you can enter a 2 digit number - that one would create as many folders as the number. then another button to just add one folder. But the one at a time would be just fine cause you can click away.

Also a click button to add docs folder (and maybe a docs subfolder that can be named) - I never just put readmes in docs alone - it is subfolders under docs of stealth mods, Overhauls, Textrure Replacers, etc.

like taking a folder with a number of ESPs and creating a sub-package for each - don't like using WB's ESP filter

So then you use this to craft several BAIN packages at the same time? No that doesn't seem like I understand - so far it has not shown me that it can see esp files - can it? What about BSA and ESM? How would it split a folder that had an esp, esm, and bsa?

Ok that is it - will get back to you as I use it some more. Already did my weekly updates - maybe a few days.