PMC Editing Wiki

User Tools

Site Tools

Trace: • infantry-metrics • sflora • alwarren-weapon-collimator-sights • v1-60-visual-upgrade-lighting-config • rsc_idx_fileformat • memrpt • convertwrp • rtm • description.ext • pgw-world-file
falcon4:tools:nsis_installer

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
falcon4:tools:nsis_installer [2007/07/12 06:56] – created nsis_installer initial page snakemanfalcon4:tools:nsis_installer [2024/07/31 10:25] (current) – links added. snakeman
Line 1: Line 1:
-====== NSIS Installer ======+====== Falcon 4 NSIS Installer ======
  
-**NSIS Installer**+[[https://www.pmctactical.org/forum/viewforum.php?f=47|Falcon 4.0 Forum]], [[:falcon4|Falcon 4 Home]], [[falcon4:campaign|Falcon 4 Campaign]], [[falcon4:cockpits|Falcon 4 Cockpits]], [[falcon4:database|Falcon 4 Database]], [[falcon4:file_formats|Falcon 4 File Formats]], [[falcon4:srtm|Falcon 4 SRTM Terrain]], [[falcon4:terrain|Falcon 4 Terrain]], [[falcon4:textures|Falcon 4 Textures]], [[falcon4:tools|Falcon 4 Tools]] 
 + 
 +**Falcon 4 Theater NSIS Installer** by PMC 
 + 
 +The NSIS installer is quite nice as its free to download and very light weight, its script based so you can tweak the installer to do pretty much anything you want. Sure the script at first looks pretty intimidating, but dont let that scare you, we have the wiki to help you out.
  
 Here in PMC Tactical we use NSIS installer to build our theater installers, also FreeFalcon/RedViper is using this method for their installation. Its very nice freeware open source program. Here in PMC Tactical we use NSIS installer to build our theater installers, also FreeFalcon/RedViper is using this method for their installation. Its very nice freeware open source program.
  
 The scripting is relatively easy for a non-coder to figure out, but is still powerful and flexible. It has a strong user community and good open-source support. It also is "portable" in that there is a version which can run from almost any PC on USB memory stick. The scripting is relatively easy for a non-coder to figure out, but is still powerful and flexible. It has a strong user community and good open-source support. It also is "portable" in that there is a version which can run from almost any PC on USB memory stick.
 +
 +
 +====== Theater Subdirs ======
 +
 +First you should setup your theater directories in preparations for the NSIS to build the installer. It doesn't really matter what you call the source directory as you can configure it on the script, but we call it here **Theater_src_THEATERNAME** where the theatername of course is like Europe, DesertStorm or Vietnam in our case.
 +
 +In the "root" theater source dir you got two directories called, Theaters and Utilities. We chose to use the Utilities dir which is included in the default RedViper installation to store its utils/tools. And naturally the Theaters dir is the one which we use to suit [[falcon4:dirstruct|PMC Theater Directory Structure]] which so far everyone (except Naldo) has agreed to use.
 +
 +In the utilities dir you place the utils, these are lstupdate.exe, LxNormalFix.exe, SeasonSwitcher.exe and Htti.exe filenames.
 +
 +So in short, you have directory of
 +<code>
 +Theater_src_DesertStorm\Theaters\DesertStorm\
 +</code>
 +Which would be your root directory for the ODS theater (later in this doc as we refer to root, this is the dir), in this root directory you have the art, campaign, objects and terrdata directories. Also there is theater selection TDF, TGA files and any readme files you wish the users to see (in our case, its the EULA.txt and version.txt).
 +
 +
 +====== Art dir ======
 +
 +Art directory is for the user interface files. Our base system includes the art\resource\ directory which contains two UI files, these are campmap and select which in our experience are universal for all F4 versions. As you need to include the individual UI files for different F4 versions in the art-AF, art-OF and art-RV directories, the main art\ dir is where you place the resource dir.
 +
 +As seen here
 +<code>
 +art\resource\
 +art\art-AF\
 +art\art-OF\
 +art\art-RV\
 +</code>
 +
 +When we examine the individual directories more we'll find these following subdirs.
 +
 +**art-AF\**
 +<code>
 +art\art-AF\campaign\
 +art\art-AF\main\
 +art\art-AF\resource\
 +</code>
 +
 +Notice how art-OF\ requires yet another "art" subdir to work.
 +
 +**art-OF\**
 +<code>
 +art\art-OF\art\main\
 +art\art-OF\art\resource\
 +</code>
 +
 +**art-RV\**
 +<code>
 +art\art-RV\main\
 +art\art-RV\resource\
 +</code>
 +
 +You should refer to our [[falcon4:ui|user interface]] namespace for details how to edit Falcon 4 UI.
 +
 +
 +====== Campaign dir ======
 +
 +Campaign dir includes the common files used for all campaigns, as well the individual campaign directory files required for all possible campaigns. The sub directories in main campaign dir are as follows.
 +
 +Campaign subdirs for our DesertStorm theater
 +<code>
 +campaign\common\
 +campaign\common-AF\
 +campaign\common-OF\
 +campaign\common-RV\
 +campaign\desertstorm1\
 +campaign\desertstorm2\
 +</code>
 +
 +When we look closer, we find that the common\ directory contains these following files: instant.cam, kneemap.gif, te_new.tac, desertstorm.idx/.wch, desertstorm.pak and desertstorm.thr. These are the files that are common/same for all the campaign directories we are creating.
 +
 +In the common-AF\, common-OF\ and common-RV\ dirs we have files for each specific F4 version, in this case strings.idx/.wch files.
 +
 +Finally in the desertstorm1\ and desertstorm2\ dirs we have the specific files required for each campaign, these are usually save0.cam, save0.tri and save1/2 also.
 +
 +You should refer to our [[falcon4:campaign|campaign]] namespace for details how to edit Falcon 4 campaigns.
 +
 +
 +====== Objects dir ======
 +
 +To install new objects, objects and including new skins to your theater, you need to create **objects* subdir into the root. In the objects dir create AF, OF and RV sub directories. In these subdirs you place the edited database files.
 +
 +As seen here
 +<code>
 +objects\AF\FALCON4.WLD
 +objects\OF\FALCON4.WLD
 +objects\RV\FALCON4.WLD
 +</code>
 +
 +In this case the falcon4.wld file is the edited loadouts for aircrafts.
 +
 +You should refer to our [[falcon4:database|database]] namespace for details how to edit Falcon 4 database.
 +
 +
 +====== Terrdata dir ======
 +
 +Terrdata directory is where the terrain\ and texture\ sub directories are located.
 +
 +As you can see
 +<code>
 +terrdata\terrain\
 +terrdata\texture\
 +</code>
 +
 +Of course if your theater uses only default korean tiles, you dont need texture\ subdir.
 +
 +In the terrain\ sub dir you find theater.L2/.O2, theater.map and theater.mea files, rest of the theater files are created with the [[falcon4:tools:sptinstall|terrain rebuilder]] util.
 +
 +In the texture\ sub dir (if you need it) you find fartiles.pal, texture.bin and texture.zip files.
 +
  
 ====== Example Script ====== ====== Example Script ======
Line 12: Line 126:
  
 <code> <code>
-!define TNAME "Vietnam"  +!define TNAME "Vietnam" 
-!define FRIENDLYNAME "PMC Vietnam Theater Installer"  +!define FRIENDLYNAME "PMC Vietnam Theater Installer" 
-!define APP "VietnamInstaller"  +!define APP "VietnamInstaller" 
-;for some reason, this has to be #.#.#.# but I usually change the name after I build the exe  +;for some reason, this has to be #.#.#.# but I usually change the name after I build the exe 
-!define VER "0.0.0.9" +!define VER "0.0.0.9"
  
-; these establish some things about the installer the most important one to me is the outfile  +; these establish some things about the installer the most important one to me is the outfile 
-Name "${FRIENDLYNAME}"  +Name "${FRIENDLYNAME}" 
-; outfile is the name of the installer.  Unless otherwise set, it will be the same directory as where the script is  +; outfile is the name of the installer.  Unless otherwise set, it will be the same directory as where the script is 
-OutFile "PMC_${TNAME}_Theater_v${VER}.exe"  +OutFile "PMC_${TNAME}_Theater_v${VER}.exe" 
-Caption "${FRIENDLYNAME}"  +Caption "${FRIENDLYNAME}" 
-; these VI definitions are what is displayed if you hover the mouse over the icon  +; these VI definitions are what is displayed if you hover the mouse over the icon 
-VIProductVersion "${VER}"  +VIProductVersion "${VER}" 
-VIAddVersionKey ProductName "${FRIENDLYNAME}"  +VIAddVersionKey ProductName "${FRIENDLYNAME}" 
-VIAddVersionKey Comments "Installs the ${TNAME} theater."  +VIAddVersionKey Comments "Installs the ${TNAME} theater." 
-VIAddVersionKey LegalCopyright "PMC Tactical"  +VIAddVersionKey LegalCopyright "PMC Tactical" 
-VIAddVersionKey FileDescription "${FRIENDLYNAME}"  +VIAddVersionKey FileDescription "${FRIENDLYNAME}" 
-VIAddVersionKey FileVersion "${VER}"  +VIAddVersionKey FileVersion "${VER}" 
-VIAddVersionKey ProductVersion "${VER}"  +VIAddVersionKey ProductVersion "${VER}" 
-VIAddVersionKey InternalName "${FRIENDLYNAME}" +VIAddVersionKey InternalName "${FRIENDLYNAME}"
  
-;=== Runtime Switches  +;=== Runtime Switches 
-; the CRC check is something I use on bigger installers to make sure everything checks out.  +; the CRC check is something I use on bigger installers to make sure everything checks out. 
-CRCCheck On  +CRCCheck On 
-; this makes it more efficient  +; this makes it more efficient 
-AutoCloseWindow True  +AutoCloseWindow True 
-; this is something I use to make sure it uses the LZMA compression, which I believe is the best  +; this is something I use to make sure it uses the LZMA compression, which I believe is the best 
-SetCompressor lzma  +SetCompressor lzma 
-; branding text is just something that's displayed at the bottom of the installer  +; branding text is just something that's displayed at the bottom of the installer 
-BrandingText "http://tactical.nekromantix.com" +BrandingText "https://www.pmctactical.org"
  
-;=== Includes - this will include the necessary dlls and functions that I use in the installer  +;=== Includes - this will include the necessary dlls and functions that I use in the installer 
-; MUI 1.67 compatible ------  +; MUI 1.67 compatible ------ 
-!include "MUI.nsh"  +!include "MUI.nsh" 
-!include "Registry.nsh"  +!include "Registry.nsh" 
-!include "WinMessages.nsh"  +!include "WinMessages.nsh" 
-!include "TextFunc.nsh"  +!include "TextFunc.nsh" 
-!include "Sections.nsh" +!include "Sections.nsh"
  
-; MUI Settings - the MUI is the Modern UI for NSIS, this section defines its parameters (there are alot more that I don't use)  +; MUI Settings - the MUI is the Modern UI for NSIS, this section defines its parameters (there are alot more that I don't use) 
-!define MUI_ABORTWARNING  +!define MUI_ABORTWARNING 
-!define MUI_INSTALLCOLORS /windows +!define MUI_INSTALLCOLORS /windows
  
-; Welcome page - this is the first page of the installer (I also have a snippet for a splashscreen, but we'll keep this simple)  +; Welcome page - this is the first page of the installer (I also have a snippet for a splashscreen, but we'll keep this simple) 
-;!define MUI_WELCOMEFINISHPAGE_BITMAP "@@:\FF4Installers\leftgraphic.bmp"  +;!define MUI_WELCOMEFINISHPAGE_BITMAP "@@:\FF4Installers\leftgraphic.bmp" 
-; using the variables means we don't have to remember to change all these when we use the template for another theater  +; using the variables means we don't have to remember to change all these when we use the template for another theater 
-!define MUI_WELCOMEPAGE_TITLE "${FRIENDLYNAME} ${VER} Setup Wizard"  +!define MUI_WELCOMEPAGE_TITLE "${FRIENDLYNAME} ${VER} Setup Wizard" 
-!define MUI_WELCOMEPAGE_TEXT "Setup will install ${FRIENDLYNAME} ${VER} into your Falcon installation."  +!define MUI_WELCOMEPAGE_TEXT "Setup will install ${FRIENDLYNAME} ${VER} into your Falcon installation." 
-!insertmacro MUI_PAGE_WELCOME +!insertmacro MUI_PAGE_WELCOME
  
-!define MUI_LICENSEPAGE_RADIOBUTTONS  +!define MUI_LICENSEPAGE_RADIOBUTTONS 
-!insertmacro MUI_PAGE_LICENSE "Theater_src_${TNAME}\Theaters\${TNAME}\EULA.txt" +!insertmacro MUI_PAGE_LICENSE "Theater_src_${TNAME}\Theaters\${TNAME}\EULA.txt"
  
-; Instfiles page  +; Instfiles page 
-!define MUI_FINISHPAGE_NOAUTOCLOSE  +!define MUI_FINISHPAGE_NOAUTOCLOSE 
-!insertmacro MUI_PAGE_INSTFILES  +!insertmacro MUI_PAGE_INSTFILES 
-; Finish page - this is the last page people see  +; Finish page - this is the last page people see 
-!define MUI_FINISHPAGE_TITLE "${FRIENDLYNAME} ${VER} Installation completed."  +!define MUI_FINISHPAGE_TITLE "${FRIENDLYNAME} ${VER} Installation completed." 
-!define MUI_FINISHPAGE_TEXT "Click 'Finish' to close this wizard."  +!define MUI_FINISHPAGE_TEXT "Click 'Finish' to close this wizard." 
-!insertmacro MUI_PAGE_FINISH +!insertmacro MUI_PAGE_FINISH
  
-; Language files  +; Language files 
-!insertmacro MUI_LANGUAGE "English"  +!insertmacro MUI_LANGUAGE "English" 
-; MUI end ------ +; MUI end ------
  
-; now we're ready for the actual installer!  +; now we're ready for the actual installer! 
-Section "Installer" SEC01 +Section "Installer" SEC01
  
-; F4registry check - if no F4 registry, it kicks to the end - the $0 is a variable that holds the -1 (not found) or 0 (found)  +; F4registry check - if no F4 registry, it kicks to the end - the $0 is a variable that holds the -1 (not found) or 0 (found) 
-; we can also start to determine which install we have  +; we can also start to determine which install we have 
-${registry::KeyExists} "HKLM\Software\MicroProse\Falcon\4.0" $0  +${registry::KeyExists} "HKLM\Software\MicroProse\Falcon\4.0" $0 
-${registry::KeyExists} "HKLM\Software\Lead Pursuit\Battlefield Operations\Falcon" $1  +${registry::KeyExists} "HKLM\Software\Lead Pursuit\Battlefield Operations\Falcon" $1 
-; IntCmp compares the integer in $0 with our number (0) and if it is =, it goes to label "F4Exists"  +; IntCmp compares the integer in $0 with our number (0) and if it is =, it goes to label "F4Exists" 
-IntCmp $0 0 F4Exists  +IntCmp $0 0 F4Exists 
-IntCmp $1 0 AFInstall  +IntCmp $1 0 AFInstall 
-; this copies the string to $9 - I'm using that as an error label  +; this copies the string to $9 - I'm using that as an error label 
-StrCpy $9 "No appropriate registry found."  +StrCpy $9 "No appropriate registry found." 
-Goto Error +Goto Error
  
 F4Exists: F4Exists:
Line 113: Line 227:
 IfFileExists $0\terrdata\objects\KoreaObj.lod OFFound NoFileFound IfFileExists $0\terrdata\objects\KoreaObj.lod OFFound NoFileFound
  
-NoFileFound:  +NoFileFound: 
-StrCpy $9 "No F4 install found."  +StrCpy $9 "No F4 install found." 
-Goto Error +Goto Error
  
-; I want to set up a variable to differentiate OF and RV  +; I want to set up a variable to differentiate OF and RV 
-RVFound:  +RVFound: 
-; we'll use this for the lstupdate variable  +; we'll use this for the lstupdate variable 
-StrCpy $8 "F4"  +StrCpy $8 "F4" 
-StrCpy $7 "RV"  +StrCpy $7 "RV" 
-Goto F4Install +Goto F4Install
  
-OFFound:  +OFFound: 
-StrCpy $8 "F4"  +StrCpy $8 "F4" 
-StrCpy $7 "OF"  +StrCpy $7 "OF" 
-Goto F4Install +Goto F4Install
  
-AFInstall:  +AFInstall: 
-; get the AF base directory into a variable  +; get the AF base directory into a variable 
-ReadRegStr $0 HKLM "Software\Lead Pursuit\Battlefield Operations\Falcon" "basedir"  +ReadRegStr $0 HKLM "Software\Lead Pursuit\Battlefield Operations\Falcon" "basedir" 
-; sets the right campaign directory  +; sets the right campaign directory 
-StrCpy $1 "$0\campaign\korea" ; campaing\save string  +StrCpy $1 "$0\campaign\korea" ; campaing\save string 
-StrCpy $2 "$0\Utilities\LxNormalFix.exe $$LP @${TNAME} @$0\Theaters\${TNAME}\terrdata" ; lxnormalfix string  +StrCpy $2 "$0\Utilities\LxNormalFix.exe $$LP @${TNAME} @$0\Theaters\${TNAME}\terrdata" ; lxnormalfix string 
-StrCpy $8 "AF"  +StrCpy $8 "AF" 
-Goto CreateDirs +Goto CreateDirs
  
-F4Install:  +F4Install: 
-ReadRegStr $0 HKLM "Software\MicroProse\Falcon\4.0" "basedir"  +ReadRegStr $0 HKLM "Software\MicroProse\Falcon\4.0" "basedir" 
-StrCpy $1 "$0\campaign\save"  +StrCpy $1 "$0\campaign\save" 
-StrCpy $2 "$0\Utilities\LxNormalFix.exe @${TNAME} @$0\Theaters\${TNAME}\terrdata" +StrCpy $2 "$0\Utilities\LxNormalFix.exe @${TNAME} @$0\Theaters\${TNAME}\terrdata"
  
-CreateDirs:  +CreateDirs: 
-SetOutPath $0 +SetOutPath $0
 CreateDirectory "$0\Theaters\${TNAME}\campaign\vietnam1\" CreateDirectory "$0\Theaters\${TNAME}\campaign\vietnam1\"
 CreateDirectory "$0\Theaters\${TNAME}\campaign\vietnam2\" CreateDirectory "$0\Theaters\${TNAME}\campaign\vietnam2\"
Line 175: Line 289:
 CopyFiles "$0\terrdata\korea\weather\*.*" "$0\Theaters\${TNAME}\terrdata\weather\" CopyFiles "$0\terrdata\korea\weather\*.*" "$0\Theaters\${TNAME}\terrdata\weather\"
  
-; unpack the theater files  +; unpack the theater files 
-; this is the subdir in the developer's PC that has the files for AF  +; this is the subdir in the developer's PC that has the files for AF 
-File /r "Theater_src_${TNAME}\*.*" +File /r "Theater_src_${TNAME}\*.*"
  
 ; common campaign dirs ; common campaign dirs
Line 229: Line 343:
 ; end of falcon version DATABASE & UI ; end of falcon version DATABASE & UI
  
-StrCmp $8 "F4" F4curTheater TheaterAdmin +StrCmp $8 "F4" F4curTheater TheaterAdmin
  
-StrCpy $9 "Unknown error before curTheater: $8."  +StrCpy $9 "Unknown error before curTheater: $8." 
-Goto Error +Goto Error
  
-F4curTheater:  +F4curTheater: 
-; set current theater to new theater +; set current theater to new theater
 ; this reads the specified registry value into $2 for use later ; this reads the specified registry value into $2 for use later
 ReadRegStr $3 HKLM "Software\MicroProse\Falcon\4.0" "curTheater" ReadRegStr $3 HKLM "Software\MicroProse\Falcon\4.0" "curTheater"
Line 243: Line 357:
 StrCmp $7 "OF" TheaterAdmin StrCmp $7 "OF" TheaterAdmin
  
-; this will be the area where we do stuff that it doesn't really matter which install it is  +; this will be the area where we do stuff that it doesn't really matter which install it is 
-TheaterAdmin:  +TheaterAdmin: 
-SetOutPath $0 +SetOutPath $0
  
 ExecWait "$0\Utilities\lstupdate.exe $8 +Theaters\${TNAME}\${TNAME}1.tdf" ExecWait "$0\Utilities\lstupdate.exe $8 +Theaters\${TNAME}\${TNAME}1.tdf"
Line 252: Line 366:
 ExecWait "$0\Utilities\LxNormalFix.exe $2" ExecWait "$0\Utilities\LxNormalFix.exe $2"
  
-; just compress textures if F4 then finish  +; just compress textures if F4 then finish 
-StrCmp $8 "AF" Finish  +StrCmp $8 "AF" Finish 
-ExecWait "$0\Utilities\SeasonSwitcher.exe -0" +ExecWait "$0\Utilities\SeasonSwitcher.exe -0"
  
-MessageBox MB_YESNO "Do you want to make the new theater the current one?" IDYES Finish IDNO OldReg  +MessageBox MB_YESNO "Do you want to make the new theater the current one?" IDYES Finish IDNO OldReg 
-OldReg:  +OldReg: 
-${registry::Write} "hklm\SOFTWARE\MicroProse\Falcon\4.0" "curTheater" "$3" "REG_SZ" $R0 +${registry::Write} "hklm\SOFTWARE\MicroProse\Falcon\4.0" "curTheater" "$3" "REG_SZ" $R0
  
-Goto Finish +Goto Finish
  
-Error:  +Error: 
-Messagebox MB_OK $9 +Messagebox MB_OK $9
  
-Finish: +Finish:
  
 SectionEnd SectionEnd
Line 272: Line 386:
 Sorry for the long code, but thats the whole script we used to build Vietnam theater installer. Sorry for the long code, but thats the whole script we used to build Vietnam theater installer.
  
-Check out our offical [[http://tactical.nekromantix.com/forum/viewtopic.php?t=20958|NSIS installer]] topic.+Check out our offical [[https://www.pmctactical.org/forum/viewtopic.php?t=20958|PMC Tactical Forum NSIS installer]] topic.
  
 ====== Notes ====== ====== Notes ======
  
 Homepage of [[http://nsis.sourceforge.net|NSIS]]. Homepage of [[http://nsis.sourceforge.net|NSIS]].
 +
falcon4/tools/nsis_installer.1184223389.txt.gz · Last modified: 2007/07/12 06:56 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

All PMC web site download services are temporarily suspended until web site yearly fees have been recovered, want to download addons/mods? Then Support PMC.

If you are grateful for all the work PMC has done in the past 25 years, use Support PMC page.