FAQ  •  Register  •  Login

UberDemon's Quick (Aircraft) Mod Installer (UQMI) for UP3RC4

<<

danzigzag

Mod Member

Posts: 140

Joined: Wed Nov 14, 2007 1:57 am

Post Mon Feb 20, 2012 12:37 am

UberDemon's Quick (Aircraft) Mod Installer (UQMI) for UP3RC4

[center]UberDemon's Quick (Aircraft) Mod Installer (UQMI) for UP3RC4
------------------------------------------------------------
by UberDemon, 19 February 2012
[/center]

Let's face it, installing new plane MODs in IL-2 1946 can be a pain, especially having to modify the "ini" and "properties" files. This little set of batch files provides a crude way to help us through our struggle. UQMI complements JSGME.


COMPATIBILITY
=============
UQMI only works with UltraPack (UP) 3 RC 4:
http://ultrapack.il2war.com/index.php

It is also compatible with Self-Static planes from SAS~Epervier, if available.
http://www.sas1946.com/main/index.php/t ... 399.0.html

For aircraft that need DiffFM, you will need that installed as well. You can find a working version for UP3RC4 here:
http://uberdemon.sushicereal.com/dzzmods/UPDiffFM.zip

Always install the latest "buttons" file from SAS from here:
http://www.sas1946.com/main/index.php/topic,97.0.html

It could theoretically work with Dark Blue World or HistoMod, or ModAct, but keeping multiple versions is a challenge, and in the case of DBW, the way the Air.ini is setup with dividers, it just does not work well for automatic updates. If somebody wants to modify this to work with those modpacks, have at it.


DISCLAIMER
==========
UQMI is not sophisticated, but I figure a quick solution is welcome. I have been using it personally for about 2 months and it works suprisingly well. Installing and uninstalling planes is much easier now.

This is meant for people who are adept at manipulating files in their computer. Be warned that editing files in your simulator may cause it to crash and never start again. If you do not feel comfortable with this, you may want to have multiple installations so that you can experiment with MODs, or you may simply not wish to use it. I am not responsible for any happiness or grief resulting from the use of this utility. Use as is. This utility contains NO malicious logic such as viruses, malware and such, and will NOT collect any personal information from your computer or your network, but using batch files can be unforgiving.


CONCEPT AND GENERAL USE
=======================
Assuming that most of the people who install their MODs do so through the JSGME interface, then you can install a new mod by creating a package that mimics the folder structure of your mod pack. Here I will only cover UltraPack (UP 3 RC 4), the most popular mega-set for MODs for '1946; it has arguably the best GUI, and it is a nice balance between HistoMod which is made for Online play, and Dark Blue World (DBW) which is for Offline only.

That is fine and dandy, but you still have to edit files like "air.ini", "plane.properties", "plane_ru.properties", etc. And as you remove the mods you have to keep track of what version of your files you are in, potentially causing CTDs (Crash to Desktop) when loading '46.

I created a set of BATCH files, yes, good old DOS-like legacy ".bat" files, to take care of this problem in a semi crude way, but it still works. Let's say a MODder creates a MOD package for JSGME, and includes the UQMI files, then all you would have to do after you installed the MOD through GME is to go to the "jsgmemods" folder in the IL-2 1946 folder, then go to the MOD's folder and subsequently to the "documentation" folder.

The "documentation" folder of the MODs in GME does not get installed or moved. Go there and run the proper batch file ("UP_installWithUQMI.bat") and VIOLA!!! I mean VOILA!!! Your config files are updated with the new airplane (or airplanes, because it can handle multiple aircraft packs).

And if you want to remove the mod, then remove it through GME as usual, then return to the "documentation" folder of the same MOD and run the "restore" utility ("UP_restoreLast.bat").

WARNING: For most cases, only uninstall from the most recent to the oldest, otherwise you may create an unstable environment requiring uninstalling and re-installing MODs. You could always uninstall a bunch of mods, say the last 5 mods with aircraft then just run "restore" from the last one you removed... that will work fine as well.

All UQMI packages install to one MOD directory, so they are all consolidated.


WHAT UQMI DOES
==============
UQMI needs JSGME to work. Once you install the core files with JSGME, then you use UQMI to update "ini" and "properties" files.

When you run UQMI, it takes some information from a few text files, then it inserts them in the proper files so that the new airplane will be available in IL-2.

The most important update it does is to Air.ini. It basically inserts the new plane in alphabetical order based on what team is its default (1 = Red/Allies, 2 = Blue/Axis according to original IL-2 configuration), it then reorganizes Air.ini in the following manner:

1) Red Team aircraft from A-Z based on the code abbreviation for the plane (not the text display)
2) Blue Team aircraft from A-Z based on same criteria above
3) Red Team Aces from A-Z based on same criteria above
4) Blue Team Aces from A-Z based on same criteria above

If information is available for Text display, weapons and self-static is included, then it will update those as well.

UQMI will update both default English files and "_ru" files, that way you don't have to worry about it.

Finally, it creates a backup of the last version of the "ini" and "properties" files.

If you uninstall a UQMI mod, then the uninstallation process restore the last version of "ini" and "properties" prior to aircraft mod being installed.


REQUIREMENTS
============
I - A PC running IL-2 1946 Modded with:

* UltraPack UP3RC4

II - MOD Folder installed and ready to go for your mod package:

* #UP# for UP3RC4 (if you have not done any MODs to UP, look at the UP installation files and you will find "#UP#SampleFolder.rar" - make sure you extract its contents to the IL-2 1946 folder)


DOWNLOAD AND INSTALLATION
=========================
Download core UQMI installation from:
http://uberdemon.sushicereal.com/dzzmod ... es/UQMI.7z

UQMI works best if you start from UP3RC4 stock settings. You will see that there are plenty of UQMI packs I created that you can use already and you will be able to convert your favorite plances to UQMI sets very easily.

If you have other planes installed, please uninstall them, through JSGME, and return UP3RC4 to its stock configuration. You DO NOT need to worry about other MODs as long as they do not use the "air", "stationary", "technics", "plane" and "weapons".

Extract the contents of the installation file you downloaded to the root directory of IL-2 1946. It will not overwrite anything so click "Yes" to anything Windows ask.

Go to the "jsgmemods" folder in Windows explorer. Note there are three new folders there:
1) #0_UP_UQMI_PlaneHolderDONT_REMOVE
- Creates a location for all UQMI Mods

2) #0_UP_UQMI_INIFilesDONT_REMOVE
- Backs up UP3RC4 files (through GME)
- Copies Air.ini files which fix issues with original UP3RC4 stock planes
- Copies "stationary", "technics", "plane" and "weapons" files from stock UP3RC4
- "stationary" and "technics" have self-stationary plane parameters

3) #UP_UQMI_Plane_NewIL2I(UQMISample)
- Sample Mod to try UQMI. It lincludes a MOD I previously released with the IL-2I with bomb loads, as historically it was able to carry (50/100/250Kg bombs). If you install my SuperAddon later, make sure you remove this, as it already includes it.

Start JSGME. Install following JSGME mods (using ">" button) in order:
1) Install #0_UP_UQMI_PlaneHolderDONT_REMOVE
2) Install #0_UP_UQMI_INIFilesDONT_REMOVE

Close JSGME.

The basic infrastructure is now installed.


INSTALLING YOUR FIRST MOD PLANE
===============================

Start JSGME. Install the following JSGME mod (using ">" button):
* #UP_UQMI_Plane_NewIL2I(UQMISample)

Close JSGME.

In Windows explorer go to "jsgmemods" folder in the IL-2 1946 folder. Now go to folder "#UP_UQMI_Plane_NewIL2I(UQMISample)"; then go to "documentation" folder.

**** IMPORTANT ****** READ BELOW ********
IF IL-2 1946 is NOT installed in default "C:\Program Files (x86)" or "C:\Program Files" in Win Vistal or 7 then follow CASE 1. (The easier CASE)

IF IL-2 1946 is installed in default "C:\Program Files (x86)" or "C:\Program Files" in Win Vistal or 7 then follow CASE 2. (I highly recommend installing IL-2 1946 anywhere but in that directory, because it is impossible to edit files in those directories without Windows giving you every grief possible.)

*** CASE 1
* Double Click on the proper installation batch file to run UQMI (UP_installWithUQMI.bat for UltraPack UP3RC4)
* Start IL-2 1946 and go play.


*** CASE 2
* Copy the file "cmd.exe" from "C:\Windows\System32" folder into the current "documentation" folder for your MOD - this is the executable that opens a command prompt DOS window
* Right click on "cmd.exe" and "Run as Administrator" - you HAVE to do this!
* DOS window opens in the "documentation" directory
* Type the name of the proper installation batch file to run UQMI then press Enter ("UP_installWithUQMI" for UltraPack UP3RC4)
* Start IL-2 1946 and go play.

For evey UQMI MOD you install, you would do these steps.


UNINSTALLING SAMPLE MOD
=======================
Start JSGME. Uninstall/Remove the following JSGME mod (using "<" button):
* #UP_UQMI_Plane_NewIL2I(UQMISample)

Close JSGME.

In Windows explorer go to "jsgmemods" folder in the IL-2 1946 folder. Now go to folder "#UP_UQMI_Plane_NewIL2I(UQMISample)"; then go to "documentation" folder.

**** IMPORTANT ****** READ BELOW ********
IF IL-2 1946 is NOT installed in default "C:\Program Files (x86)" or "C:\Program Files" in Win Vistal or 7 then follow CASE 1. (The easier CASE)

IF IL-2 1946 is installed in default "C:\Program Files (x86)" or "C:\Program Files" in Win Vistal or 7 then follow CASE 2. (I highly recommend installing IL-2 1946 anywhere but in that directory, because it is impossible to edit files in those directories without Windows giving you every grief possible.)

*** CASE 1
* Double Click on the proper batch file to run restoration to last state before this mod (UP_restoreLast.bat for UltraPack UP3RC4)


*** CASE 2
* If "cmd.exe" is not in your folder, copy it from "C:\Windows\System32" folder into the current "documentation" folder for your MOD - this is the executable that opens a command prompt DOS window
* Right click on "cmd.exe" and "Run as Administrator" - you HAVE to do this!
* DOS window opens in the "documentation" directory
* Type the name of the proper batch file to run restorarion then press Enter ("UP_restoreLast" for UltraPack UP3RC4)

For evey UQMI MOD you uninstall, you would do these steps.

TROUBLESHOOTING AND PROBLEMS WITH WINDOWS VISTA AND WINDOWS 7
=============================================================
If you install any of the UQMI packs I made available they all work. So what now?

Do you have the latest "buttons" installed? If not then read "COMPATIBILITY" section.

Do you have DiffFM installed? If not then read "COMPATIBILITY" section.

If these are not reasons... then most likely you did not read the installation concerning the problems with Windows Vista and Windows 7. If you have IL-2 1946 installed in the default "Program Files" directory in the "C" drive, and you did not follow the directions, you have not installed any MOD. You may think you did, but you didn't.

For some reason, Windows Vista and Windows 7 do not care if you are the Administrator... you cannot edit text files in protected directories... you can be God and Windows will still not let you do it... You can only edit files and save them if you start NOTEPAD in administrator mode... it is a pain. The same goes for running batch files... you can only do that if you are running CMD or COMMAND in Administrator mode, otherwise, files will not be copied or edited. You may think they did, but they didn't.

For that reason I urge you to install IL-2 1946 in ANY other directory or DRIVE in a non protected folder... something like "C:\Games\IL-2 Sturmovik 1946" etc... If you MOD your games, it will save you a lot of headaches.

If you still want to keep it there, then read sections "INSTALLING YOUR FIRST MOD PLANE" and "UNINSTALLING SAMPLE MOD" in CASE 2.

That shoud do it.


CREATING YOUR OWN UQMI AIRPLANE MOD INSTALLATION PACK
=====================================================
Dude! It is easy... After you create your first set, you should be able to create a UQMI installation pack in about a minute, or less.

I assume you already installed UQMI. First I want you to go to the IL-2 1946 directory. Notice now there is a folder there called "!UQMI". Go there. Don't mess with any files there, but if you do, then copy the files from the backup directory into it.

Make a copy of the folder "#UP_UQMI_Plane_TEMPLATE_DONTINSTALL" and place it in the "jsgmemods" folder, where all other JSGME mods are located.

Go to the "jsgmemods" folder. Let's say you want to install 101tfs/Verhängnis' Bu-181... because it is cool... First rename the "#UP_UQMI_Plane_TEMPLATE_DONTINSTALL" folder you copied there to "#UP_UQMI_Plane_Bu181".

Open the #UP_UQMI_Plane_Bu181 folder; go to #UP# folder; note there is a folder named "zz_UQMI_NewAircraft" there.

Go to the SAS announcement page at:
* http://www.sas1946.com/main/index.php/t ... 403.0.html

Download the MOD from the link in the page which is:
* http://www.mediafire.com/?088gyf82m17kzvp

Open the file "ZZBü-181.rar" with 7-Zip and go to "ZZBü-181" folder.

Select everything except for the files "README.txt" and "Flight and Operations Manual-Bu-181.pdf". Drag all the other files from the 7-Zip Window to the "zz_UQMI_NewAircraft" folder I mentioned above. Make sure the files went into that folder and not in the "#UP#" directory you have open. DON'T CLOSE 7-Zip yet.

Now go back to the "#UP_UQMI_Plane_Bu181" folder; go to "documentation" folder.

From 7-Zip, now drag files "README.txt" and "Flight and Operations Manual-Bu-181.pdf" into the "documentation" folder you have open. Overwrite the README.txt file... it is an empty file you would include information about the MOD, such as credits, etc.

Go ahead and close 7-Zip for now.

Open "ReadMe.jsgme" file in NOTEPAD and write "Bu-181 & Gomhouria Mk6 plus self stationary. Read manual in "documentation" folder." in it. Save and close.

Take note of the following files in the "documentation" folder:
* add_air.txt
--> this is where you enter code for "air.ini" (the only required file)

* add_pln.txt
--> this is where you enter text for "plane.properties" if available (don't worry about the "_ru" version... UQMI will take care of it

* add_wpn.txt
--> this is where you enter text for "weapons.properties" if available (don't worry about the "_ru" version... UQMI will take care of it

Based on the information from SAS page and the README.txt, let's enter some text.

Enter the following two lines to "add_air.txt" then save and close:
  Code:
Gomhouria-Mk6         air.Mk6 2                                g01   SUMMER
Bu-181                air.Bu_181 2                             g01   SUMMER


NOTE: Don't worry what order it is... they will be sorted alphabetically with all other planes when air.ini gets modified. IMPORTANT: Always make sure that for every MOD, the team is specified after the class name exactly as following: {SPACE}{TEAM_NUMBER}{SPACE}, in other words " 1 " or " 2 ". If TABS are used, it will NOT work.

Enter the following two lines to "add_pln.txt" then save and close:
  Code:
Gomhouria-Mk6         Gomhouria Mk6, 1950
Bu-181                Bu-181, 1939

NOTE: If you did not have this information, you would just leave the file alone. It does not get sorted because "plane.properties" does not need to match "air.ini" order

Since there is no information for "weapons.properties" in this MOD, don't worry about it, but if there was, you would simply enter all the information in the file "add_wpn.txt". For now just leave the file alone.

Now let's create the folder for skins. All you have to do is use the code in the first field from the Air.ini file.

Go back to the #UP_UQMI_Plane_Bu181 folder; go to the "PaintSchemes" folder; go to the "Skins" folder.

Create folders named "Bu-181" and "Gomhouria-Mk6"; now you can put skin files there if you have them.

If there is no "Self-Static" version of this plane available, that is it... your MOD pack is ready. You can run "Installation_Instructions.bat" for simple instructions, but basically you will follow similar instructions from "INSTALLING YOUR FIRST MOD PLANE" and "UNINSTALLING SAMPLE MOD" sections.

NOTE: DO NOT ERASE ANY FILES, even if you do not touch them.

* SELF-STATIC

Go back to the #UP_UQMI_Plane_Bu181 folder; go to #UP# folder; note again there is a folder named "zz_UQMI_NewAircraft" there.

Since this MOD has a corresponding "Self-Static" mod, so you can have static versions of the plane available in FMB, let's go get it.

Go to "Self-Static" SAS page at:
http://www.sas1946.com/main/index.php/t ... 399.0.html

Get the Bücker Bü-181 Self-Static mod from link in page above:
http://www.mediafire.com/?vvb18b32bdfd512

Open the file "Stationary_Bu-181.7z" with 7-Zip and go to "Bu-181" folder.

Select everything except for the file "_Self_Stationary_Plane.txt". Drag all the other files from the 7-Zip Window to the "zz_UQMI_NewAircraft" folder I mentioned above. Make sure the files went into that folder and not in the "#UP#" directory you have open. DON'T CLOSE 7-Zip yet.

Now go back to the "#UP_UQMI_Plane_Bu181" folder; go to "documentation" folder.

Take note of the following files in the "documentation" folder:
* add_sta.txt
--> this is where you enter self-stationary code for "stationary.ini"

* add_tec.txt
--> this is where you enter self-stationary code for "tecnics.ini"

From 7-Zip, double-click "_Self_Stationary_Plane.txt"; from this file, let's enter some information in the two files mentioned above.

Enter the following lines in "add_sta.txt" then save and close:
  Code:
Bu_181       vehicles.planes.BuckerStatic$Bu_181    2
Mk6          vehicles.planes.BuckerStatic$Mk6       2


NOTE: Enter as stated above... don't enter anything else.

Enter the following lines in "add_tec.txt" then save and close:
  Code:
[Bu_181]
Description    Bucker Bu-181
Icon           Plane
Class          air.Bu_181
PanzerType  Car
PanzerSubtype  4
PanzerBodyFront      0.004
Explode              WagonMetal

[Mk6]
Description    Gomhouria Mk.6
Icon           Plane
Class          air.Mk6
PanzerType  Car
PanzerSubtype  4
PanzerBodyFront      0.004
Explode              WagonMetal



NOTE: Enter as stated above... don't enter anything else.

Close "_Self_Stationary_Plane.txt", then 7-Zip.

Your MOD is ready. You can run "Installation_Instructions.bat" for simple instructions, but basically you will follow similar instructions from "INSTALLING YOUR FIRST MOD PLANE" and "UNINSTALLING SAMPLE MOD" sections.


WHERE CAN I GET SOME UQMI PACKS READY TO GO?
============================================
I have created several UQMI packs for my own use, and I thought I would make them available to the public. I tried to keep the READMEs and credits for everything as much as possible, so if I missed giving credit to someone, I am truly sorry. If Self-Static and/or skins are available, they are included.

Here are the links in my own site for the packs I created:
http://uberdemon.sushicereal.com/dzzmod ... don0001.7z
My addon above includes a lot of goodies:
* Il-2 Fld Mod (Player Gunner),'41
* IL-2I (Wpn Mod),'43
* IL-2T (Wpn Mod),'43
* TB-3 4M-17 (Transport Mod),'33
* TB-3 4M-34R (Transport Mod),'33
* Yak-9R (Recce Mod),'43
* FW-190 D-9 (Wpn Mod),'44
* FW-190 D-9 (Wpn Mod),'45
* FW-190 F-8/G-8 (Super Wpn Mod),'44
* Ki-43-Ia (Wpn Mod),'41
* Ki-43-Ib (Wpn Mod),'41
* Ki-43-Ic (Wpn Mod),'41
* Ki-43-II (Wpn Mod),'42
* Ki-43-II Kai (Wpn Mod),'43
* Original missions from IL-2 Demo's, and original IL-2 upgrades
* Missions from glider releases

Other packs are included below:
http://uberdemon.sushicereal.com/dzzmod ... Z506_AI.7z
http://uberdemon.sushicereal.com/dzzmod ... 11_IK-3.7z (flyable)
http://uberdemon.sushicereal.com/dzzmod ... 11_IL-4.7z (new 411 cockpit)
http://uberdemon.sushicereal.com/dzzmod ... 11_Pe-8.7z (new 411 cockpit)
http://uberdemon.sushicereal.com/dzzmod ... astator.7z (flyable)
http://uberdemon.sushicereal.com/dzzmod ... e_B-24D.7z
http://uberdemon.sushicereal.com/dzzmod ... ne_B-26.7z
http://uberdemon.sushicereal.com/dzzmod ... -65Pack.7z
http://uberdemon.sushicereal.com/dzzmod ... e_Bu181.7z
http://uberdemon.sushicereal.com/dzzmod ... areship.7z
http://uberdemon.sushicereal.com/dzzmod ... derPack.7z (awesome jet!)
http://uberdemon.sushicereal.com/dzzmod ... _Dh-89a.7z
http://uberdemon.sushicereal.com/dzzmod ... rricane.7z (Hercules)
http://uberdemon.sushicereal.com/dzzmod ... okkerG1.7z
http://uberdemon.sushicereal.com/dzzmod ... r_Cargo.7z
http://uberdemon.sushicereal.com/dzzmod ... Trainer.7z
http://uberdemon.sushicereal.com/dzzmod ... aponMod.7z
http://uberdemon.sushicereal.com/dzzmod ... andingGear).7z
http://uberdemon.sushicereal.com/dzzmod ... caneFAC.7z
http://uberdemon.sushicereal.com/dzzmod ... th50Cal.7z (needs 14 Feb 2010 SAS buttons)
http://uberdemon.sushicereal.com/dzzmod ... panPack.7z (J7W1, J4M1, D4Y2, Ki-98)
http://uberdemon.sushicereal.com/dzzmod ... ctional.7z
http://uberdemon.sushicereal.com/dzzmod ... Spotter.7z
http://uberdemon.sushicereal.com/dzzmod ... atorGRV.7z
http://uberdemon.sushicereal.com/dzzmod ... 0_Betas.7z
http://uberdemon.sushicereal.com/dzzmod ... ne_P-35.7z
http://uberdemon.sushicereal.com/dzzmod ... _R-XIII.7z
http://uberdemon.sushicereal.com/dzzmod ... ne_T-33.7z
http://uberdemon.sushicereal.com/dzzmod ... Gunboat.7z
http://uberdemon.sushicereal.com/dzzmod ... arriers.7z


Enjoy,
UberDemon/danzigzag
http://uberdemon.sushicereal.com
<<

Jambo

User avatar

Site Administrator

Posts: 2008

Joined: Thu Apr 03, 2008 5:59 pm

Location: Germany

Post Fri Feb 24, 2012 3:34 am

Re: UberDemon's Quick (Aircraft) Mod Installer (UQMI) for UP

Hello danzigzag,

thank you very much indeed for this! 8)
I made this a "Sticky" as well.

Jambo :wink:
<<

danzigzag

Mod Member

Posts: 140

Joined: Wed Nov 14, 2007 1:57 am

Post Fri Feb 24, 2012 11:10 pm

Re: UberDemon's Quick (Aircraft) Mod Installer (UQMI) for UP

Jambo wrote:Hello danzigzag,

thank you very much indeed for this! 8)
I made this a "Sticky" as well.

Jambo :wink:


Thank you. Let me know what you think. In reality, it should work for MODACT and DBW, but I was just too lazy to create too many versions... with a simple replace in the batch files those versions could be created... Just a matter of which folder is the MOD folder.

UberDemon/danzigzag
<<

Raffiano

Posts: 20

Joined: Fri Jul 15, 2011 8:48 am

Post Sat Apr 28, 2012 4:32 am

Re: UberDemon's Quick (Aircraft) Mod Installer (UQMI) for UP

So if i run UP_installWithUQMI.bat, will it update new aircraft auto for me or what?

Return to UltraPack Forum.

Who is online

Users browsing this forum: No registered users and 1 guest

Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group.
Designed by ST Software for PTF.