Nullsoft Scriptable Install System

This article relies too much on references to primary sources. Please improve this by adding secondary or tertiary sources. (September 2016) (Learn how and when to remove this template message)

Nullsoft Scriptable Install System

NSIS Installer
Original author(s)	Nullsoft
Developer(s)	NSIS Team and NSIS Community
Initial release	31 July 2000; 21 years ago (2000-07-31)[1]
Stable release	3.08 / 25 September 2021; 3 months ago (2021-09-25)
Repository	sourceforge.net/p/nsis/code/HEAD/tree/
Written in	C, C++
Operating system	Windows, Mac OS X
Type	Software development tools
License	zlib License
Website	nsis.sourceforge.io

Nullsoft Scriptable Install System (NSIS) is a script-driven installer authoring tool for Microsoft Windows backed by Nullsoft, the creators of Winamp. NSIS is released under a combination of free software licenses, primarily the zlib license.^[2] It has become a widely used alternative to commercial proprietary products like InstallShield, with users including Amazon.com, Dropbox, Google, Ubisoft, FL Studio, BitTorrent, and McAfee.^[3]

History[]

NSIS was created to distribute Winamp.^[4] It is based on a previous Nullsoft product, PiMP (plugin Mini Packager), and is also known as SuperPiMP. After version 2.0a0, the project was moved to SourceForge where developers outside Nullsoft started working on it on a regular basis. NSIS 2.0 was released approximately two years later.

NSIS version 1 is in many ways similar to the classic Windows Installer, but it supports more compression formats. NSIS version 2 features a new streamlined graphical user interface and supports LZMA compression, multiple languages, and an easy-to-use plugin system.

In January 2006 NSIS was SourceForge's project of the month.^[5][6]

Script examples[]

Hello world![]

!include "MUI.nsh"

!insertmacro MUI_LANGUAGE "English"

Name "Hello world!" # Name of the installer.
OutFile "HelloWorld.exe" # Name of the installer's file.

Function .onInit # Function that will be executed on installer's start up.
  MessageBox MB_OK|MB_ICONINFORMATION "Hello world!" # Show a message that says "Hello world!".
  Quit # Close the installer because this is a simple "Hello world!" installer.
FunctionEnd

Section # Useless section because this is a simple "Hello world!" installer.
SectionEnd

Simple installer[]

!include "MUI.nsh"

!define MUI_ABORTWARNING # This will warn the user if they exit from the installer.

!insertmacro MUI_PAGE_WELCOME # Welcome to the installer page.
!insertmacro MUI_PAGE_DIRECTORY # In which folder install page.
!insertmacro MUI_PAGE_INSTFILES # Installing page.
!insertmacro MUI_PAGE_FINISH # Finished installation page.

!insertmacro MUI_LANGUAGE "English"

Name "MyApp" # Name of the installer (usually the name of the application to install).
OutFile "MyAppInstaller.exe" # Name of the installer's file.
InstallDir "$PROGRAMFILES\MyApp" # Default installing folder ($PROGRAMFILES is Program Files folder).
ShowInstDetails show # This will always show the installation details.

Section "MyApp" # In this section add your files or your folders.
  # Add your files with "File (Name of the file)", example: "File "$DESKTOP\MyApp.exe"" ($DESKTOP is Desktop folder); or add your folders always with "File (Name of the folder)\*", always add your folders with an asterisk, example: "File /r $DESKTOP\MyApp\*" (this will add its files and (with /r its subfolders)).
SectionEnd

Simple installer that adds a shortcut in the start menu and comes with an uninstaller[]

# define name of installer
OutFile "InstallMyApp"
 
# define installation directory
InstallDir $LOCALAPPDATA\Programs\myapp
 
# For removing Start Menu shortcut in Windows 7
RequestExecutionLevel user
 
# start default section
Section
 
    # set the installation directory as the destination for the following actions
    SetOutPath $INSTDIR
 
    # create the uninstaller
    WriteUninstaller "$INSTDIR\uninstall.exe"
 
    # point the new shortcut at the program uninstaller
    CreateShortcut "$SMPROGRAMS\My App.lnk" "$INSTDIR\myapp.exe"
    CreateShortcut "$SMPROGRAMS\My App Uninstall.lnk" "$INSTDIR\uninstall.exe"

    File /r "C:\path\to\where\my\files\are\*"

SectionEnd
 
# uninstaller section start
Section "uninstall"
 
    # first, delete the uninstaller
    Delete "$INSTDIR\uninstall.exe"
 
    # second, remove the link from the start menu
    Delete "$SMPROGRAMS\My App.lnk"
    Delete "$SMPROGRAMS\My App Uninstall.lnk"
 
    Delete $INSTDIR

# uninstaller section end
SectionEnd

Concepts[]

NSIS 1.98

Script[]

The NSIS compiler program makensis compiles scripts like the following example into executable installation programs. Each line in the script contains a single command.

# Example script
Name "Example1"
OutFile "jubaowu.exe"
InstallDir "$PROGRAMFILES\Example1"
Page Directory
Page InstFiles
Section
  SetOutPath $INSTDIR
  File ..\makensis.exe
SectionEnd

Modern user interface[]

Version 2.0 introduced a new optional streamlined graphical user interface called Modern UI (MUI). The MUI has a wizard-like interface. It supports a welcome page, finish page, language selection dialog, description area for components, and greater customization options than the old user interface.

# Modern UI example script
!include MUI.nsh
Name "Example 2"
OutFile "Example2.exe"
!insertmacro MUI_PAGE_WELCOME
!insertmacro MUI_PAGE_LICENSE "license.rtf"
!insertmacro MUI_PAGE_DIRECTORY
!insertmacro MUI_PAGE_COMPONENTS
!insertmacro MUI_PAGE_INSTFILES
!insertmacro MUI_PAGE_FINISH
!insertmacro MUI_LANGUAGE "English"
!insertmacro MUI_LANGUAGE "German"
!insertmacro MUI_LANGUAGE "French"
Section "Extract makensis"
  SetOutPath $INSTDIR
  File ..\makensis.exe
SectionEnd

Since NSIS version 2.30 (Released on 25 August 2007) there is new version (beta) of this UI accessible: Modern UI 2 (MUI2) which is an enhancement to Modern UI. Unlike the old MUI this version is based on nsDialogs instead of old-fashioned InstallOptions .ini files.

From version 2.34 (Released on 24 December 2007) this MUI2 is ready for mass consumption and it is included in all NSIS packages. Also all examples had been switched to it.

Modern UI 2 documentation.

Graphical interfaces[]

NSIS projects can be configured by simply editing text files (with .nsi extension). However, several third parties provide editing software:

• EclipseNSIS is a module for the Eclipse platform. It allows NSIS scripts to be edited, compiled and validated.
• HM NIS Edit (freeware) editor with support of custom C++ or Delphi plug-ins.
• Venis (freeware) editor
• Visual & Installer is an add-in which integrates NSIS with Microsoft Visual Studio IDE and allows to create and build NSIS projects right within it.

Installer interfaces[]

Several projects that extend or replace the Modern UI have started in the past few years. Interfaces such as the ExperienceUI and UltraModernUI completely change the style of the installer by skinning it to look like the InstallShield interface. Other interfaces like installSpiderUI aim for a more minimalistic approach on the visual side of things while maintaining the same level of functionality as the ASD.

Plugins[]

NSIS can be extended with plugins that can communicate with the installer. Plugins can be written in any unmanaged programming language capable of building a dynamic-link library (such as C, C++ or Delphi), and they can be used to perform installation tasks or extend the installer interface. A plugin can be called with a single line of NSIS code.

Several plugins come with the NSIS package that permit the installer to display a splash screen, display a custom page, display an image on the background, download files from a website, perform mathematical operations, patch files and more.

Other plugins are available online, including ZipDLL, and a Python plugin.

Features[]

NSIS supports the following features:^[7]

• zlib, bzip2, and LZMA compression
• Script-based
• Multilingual
• Plugin support
• Script preprocessor

Generated installer[]

The generated installer is a Portable Executable, with the installation files archived within the installer, a 34 KB overhead for the NSIS installer,^[7] and the installation script compiled into executable code. As the installation script is compiled, the script cannot be obtained from the delivered executable without reverse-engineering the binary.

The archive may be unpacked using 7-Zip, the Total Commander plugin InstallExplorer, or the FAR Manager plugin InstallExplorer.

The archive contains several folders:

• $PLUGINSDIR : installation routine plugins
• $INSTDIR : files used during the installation
• $_OUTDIR : files to be installed.

The generated installer includes command line arguments in order to give users more control:^[8]

• /NCRC disables the CRC check, unless the script forces it
• /S runs the installer/uninstaller silently.
• /D sets the default installation directory. It must be the last parameter and must not contain any quotes. Only absolute paths are supported.

Unicode support[]

Versions of NSIS before 3.0 did not support Unicode, but only a means to convert some files to different encodings via a plugin.^[9] However, a variant of NSIS that has full Unicode support is available.^[10] Notable projects using this variant are:^[11]

• Google (Picasa)
• Apache OpenOffice for Windows
• Mozilla (Firefox, Mozilla Thunderbird)
• FileZilla
• Winamp
• Flickr
• PortableApps.com
• Second Life
• Xampp
• AVG
• TeamViewer

With the release of version 3.0 of NSIS, Unicode support can be implemented using the compiler directive "Unicode true". This gives full Unicode support with no further code changes, but the installer will not run under Windows 95/98/Me.^[12] As of 2016 before the 3.0 release NSIS was available in the PortableApps format for Unicode 2.46.5 Rev 3 and ANSI 2.51.^[13]

See also[]

• List of installation software

References[]

External links[]

Wikimedia Commons has media related to Nullsoft Scriptable Install System.

• Official website
• NSIS on SourceForge
• NSIS at Open Hub
• Unofficial 64-bit builds