Reusable installer script - Revision history

Bugmenot: /* Description & How To Use */

2014-06-25T12:55:23Z

Description & How To Use

â† Older revision		Revision as of 12:55, 25 June 2014
Line 13:		Line 13:
	'''WARNING''' The uninstaller will not uninstall the registry entries or the Program Files directories.		'''WARNING''' The uninstaller will not uninstall the registry entries or the Program Files directories.

	[== The Script ==]		== The Script ==

	<highlight-nsis>		<highlight-nsis>
Line 262:		Line 262:

	[[Category:Real World Installers]]		[[Category:Real World Installers]]
	~~]'''Bold text'''~~

146.164.66.51: /* Description & How To Use */

2013-03-12T17:12:01Z

Description & How To Use

â† Older revision		Revision as of 17:12, 12 March 2013
Line 13:		Line 13:
	'''WARNING''' The uninstaller will not uninstall the registry entries or the Program Files directories.		'''WARNING''' The uninstaller will not uninstall the registry entries or the Program Files directories.

	[== The Script ==		[== The Script ==]

	<highlight-nsis>		<highlight-nsis>

146.164.66.51: /* Description & How To Use */

2013-03-12T17:11:42Z

Description & How To Use

â† Older revision		Revision as of 17:11, 12 March 2013
Line 48:		Line 48:

	; optional stuff		; optional stuff

			; Set the text which prompts the user to enter the installation directory
			; DirText "My Description Here."

	; text file to open in notepad after installation		; text file to open in notepad after installation

41.239.212.44: /* The Script */

2011-02-04T17:23:19Z

The Script

â† Older revision		Revision as of 17:23, 4 February 2011
Line 13:		Line 13:
	'''WARNING''' The uninstaller will not uninstall the registry entries or the Program Files directories.		'''WARNING''' The uninstaller will not uninstall the registry entries or the Program Files directories.

	== The Script ==		[== The Script ==

	<highlight-nsis>		<highlight-nsis>
Line 259:		Line 259:

	[[Category:Real World Installers]]		[[Category:Real World Installers]]
			]'''Bold text'''

98.206.40.47: /* Description & How To Use */

2009-01-02T05:30:23Z

Description & How To Use

â† Older revision		Revision as of 05:30, 2 January 2009
Line 10:		Line 10:

	My usage has been to define a separate .nsi file that defines the constants for a particular app and then includes this script, so I don't have to change the contents of this file.		My usage has been to define a separate .nsi file that defines the constants for a particular app and then includes this script, so I don't have to change the contents of this file.

			'''WARNING''' The uninstaller will not uninstall the registry entries or the Program Files directories.

	== The Script ==		== The Script ==

Kichik: Reverted edits by 82.233.246.132 to last version by ConversionBot

2008-12-29T19:11:36Z

Reverted edits by 82.233.246.132 to last version by ConversionBot

Show changes

82.233.246.132: field_other

2008-12-29T14:17:54Z

field_other

Show changes

ConversionBot: Adding new author and category links.

2005-06-24T13:44:42Z

Adding new author and category links.

â† Older revision		Revision as of 13:44, 24 June 2005
Line 1:		Line 1:
	{~~\|align=right~~		{{PageAuthor\|technicat}}
	~~\|<small>Author: [[~~{~~{ns:2}}:technicat~~\|technicat~~]] ([[{{ns:3}}:technicat\|talk]], [[{{ns:-1}~~}~~:Contributions/technicat\|contrib]])</small>~~
	\|}
	~~<br style="clear:both;">~~
	== Description & How To Use ==		== Description & How To Use ==

Line 258:		Line 256:
	</highlight-nsis>		</highlight-nsis>

	[[~~{{ns:14}}~~:Real World Installers]]		[[Category:Real World Installers]]

ConversionBot: Created by user: technicat (talk, contrib).

2005-06-21T22:39:26Z

Created by user: technicat (talk, contrib).

New page

{|align=right
|<small>Author: [[{{ns:2}}:technicat|technicat]] ([[{{ns:3}}:technicat|talk]], [[{{ns:-1}}:Contributions/technicat|contrib]])</small>
|}
<br style="clear:both;">
== Description & How To Use ==

I developed this script for use among many projects. Just define the company, product name, executable and src directory constants at top - the resulting installer will query for the install location and create the appropriate start menu entries.

Optionally define an icon, license file, readme file, help file, URL, and file type, and the installer will add the appropriate entries to the start menu and set the registry to display the application data files with the application icon and handle double-clicking on the data files. (Note I didn't list all the constants at top - you'll have to browse through the script a bit to see all the names)

If you have extra files or other customizations, define additional install and uninstall files that contain the necessary additional NSIS script code.

My usage has been to define a separate .nsi file that defines the constants for a particular app and then includes this script, so I don't have to change the contents of this file.

== The Script ==

<highlight-nsis>
; basic script template for NSIS installers
;
; Written by Philip Chu
; Copyright (c) 2004-2005 Technicat, LLC
;
; This software is provided 'as-is', without any express or implied warranty.
; In no event will the authors be held liable for any damages arising from the use of this software.

; Permission is granted to anyone to use this software for any purpose,
; including commercial applications, and to alter it ; and redistribute
; it freely, subject to the following restrictions:

; 1. The origin of this software must not be misrepresented; you must not claim that
; you wrote the original software. If you use this software in a product, an
; acknowledgment in the product documentation would be appreciated but is not required.

; 2. Altered source versions must be plainly marked as such, and must not be
; misrepresented as being the original software.

; 3. This notice may not be removed or altered from any source distribution.

;!define setup "setup.exe"

; change this to wherever the files to be packaged reside
;!define srcdir "."

;!define company "Technicat"

;!define prodname "Application"
;!define exec "program.exe"

; optional stuff

; text file to open in notepad after installation
; !define notefile "README.txt"

; license text file
; !define licensefile license.txt

; icons must be Microsoft .ICO files
; !define icon "icon.ico"

; installer background screen
; !define screenimage background.bmp

; file containing list of file-installation commands
; !define files "files.nsi"

; file containing list of file-uninstall commands
; !define unfiles "unfiles.nsi"

; registry stuff

!define regkey "Software\${company}\${prodname}"
!define uninstkey "Software\Microsoft\Windows\CurrentVersion\Uninstall\${prodname}"

!define startmenu "$SMPROGRAMS\${company}\${prodname}"
!define uninstaller "uninstall.exe"

;--------------------------------

XPStyle on
ShowInstDetails hide
ShowUninstDetails hide

Name "${prodname}"
Caption "${prodname}"

!ifdef icon
Icon "${icon}"
!endif

OutFile "${setup}"

SetDateSave on
SetDatablockOptimize on
CRCCheck on
SilentInstall normal

InstallDir "$PROGRAMFILES\${company}\${prodname}"
InstallDirRegKey HKLM "${regkey}" ""

!ifdef licensefile
LicenseText "License"
LicenseData "${srcdir}\${licensefile}"
!endif

; pages
; we keep it simple - leave out selectable installation types

!ifdef licensefile
Page license
!endif

; Page components
Page directory
Page instfiles

UninstPage uninstConfirm
UninstPage instfiles

;--------------------------------

AutoCloseWindow false
ShowInstDetails show

!ifdef screenimage

; set up background image
; uses BgImage plugin

Function .onGUIInit
; extract background BMP into temp plugin directory
InitPluginsDir
File /oname=$PLUGINSDIR\1.bmp "${screenimage}"

BgImage::SetBg /NOUNLOAD /FILLSCREEN $PLUGINSDIR\1.bmp
BgImage::Redraw /NOUNLOAD
FunctionEnd

Function .onGUIEnd
; Destroy must not have /NOUNLOAD so NSIS will be able to unload and delete BgImage before it exits
BgImage::Destroy
FunctionEnd

!endif

; beginning (invisible) section
Section

WriteRegStr HKLM "${regkey}" "Install_Dir" "$INSTDIR"
; write uninstall strings
WriteRegStr HKLM "${uninstkey}" "DisplayName" "${prodname} (remove only)"
WriteRegStr HKLM "${uninstkey}" "UninstallString" '"$INSTDIR\${uninstaller}"'

!ifdef filetype
WriteRegStr HKCR "${filetype}" "" "${prodname}"
!endif

WriteRegStr HKCR "${prodname}\Shell\open\command\" "" '"$INSTDIR\${exec} "%1"'

!ifdef icon
WriteRegStr HKCR "${prodname}\DefaultIcon" "" "$INSTDIR\${icon}"
!endif

SetOutPath $INSTDIR

; package all files, recursively, preserving attributes
; assume files are in the correct places
File /a "${srcdir}\${exec}"

!ifdef licensefile
File /a "${srcdir}\${licensefile}"
!endif

!ifdef notefile
File /a "${srcdir}\${notefile}"
!endif

!ifdef icon
File /a "${srcdir}\${icon}"
!endif

; any application-specific files
!ifdef files
!include "${files}"
!endif

WriteUninstaller "${uninstaller}"

SectionEnd

; create shortcuts
Section

CreateDirectory "${startmenu}"
SetOutPath $INSTDIR ; for working directory
!ifdef icon
CreateShortCut "${startmenu}\${prodname}.lnk" "$INSTDIR\${exec}" "" "$INSTDIR\${icon}"
!else
CreateShortCut "${startmenu}\${prodname}.lnk" "$INSTDIR\${exec}"
!endif

!ifdef notefile
CreateShortCut "${startmenu}\Release Notes.lnk "$INSTDIR\${notefile}"
!endif

!ifdef helpfile
CreateShortCut "${startmenu}\Documentation.lnk "$INSTDIR\${helpfile}"
!endif

!ifdef website
WriteINIStr "${startmenu}\web site.url" "InternetShortcut" "URL" ${website}
; CreateShortCut "${startmenu}\Web Site.lnk "${website}" "URL"
!endif

!ifdef notefile
ExecShell "open" "$INSTDIR\${notefile}"
!endif

SectionEnd

; Uninstaller
; All section names prefixed by "Un" will be in the uninstaller

UninstallText "This will uninstall ${prodname}."

!ifdef icon
UninstallIcon "${icon}"
!endif

Section "Uninstall"

DeleteRegKey HKLM "${uninstkey}"
DeleteRegKey HKLM "${regkey}"

Delete "${startmenu}\*.*"
Delete "${startmenu}"

!ifdef licensefile
Delete "$INSTDIR\${licensefile}"
!endif

!ifdef notefile
Delete "$INSTDIR\${notefile}"
!endif

!ifdef icon
Delete "$INSTDIR\${icon}"
!endif

Delete "$INSTDIR\${exec}"

!ifdef unfiles
!include "${unfiles}"
!endif

SectionEnd
</highlight-nsis>

[[{{ns:14}}:Real World Installers]]