Nullsoft Scriptable Install System

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Not to be confused with NCIS (disambiguation).
Nullsoft Scriptable Install System
NSIS screenshot.png
NSIS Installer
Developer(s) Nullsoft
Stable release 2.46 / 6 December 2009; 4 years ago (2009-12-06)
Preview release 3.0b1 / 6 October 2014; 52 days ago (2014-10-06)
Written in C, C++
Operating system Windows, POSIX
Type Software development tools
License zlib license
Website nsis.sourceforge.net

Nullsoft Scriptable Install System (NSIS) is a script-driven installation system for Microsoft Windows with minimal overhead backed by Nullsoft, the creators of Winamp. NSIS has become a widely used alternative to commercial and proprietary products like InstallShield, with users including Amazon, Dropbox, Ubisoft, BitTorrent, and McAfee.[1]

NSIS is free software released under a combination of free software licenses, primarily the zlib license.[2]

History[edit]

NSIS was created to distribute Winamp. 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 of 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 is easier to script and 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.

Concepts[edit]

NSIS 1.98

Script[edit]

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 "example1.exe"
InstallDir "$PROGRAMFILES\Example1"
Page Directory
Page InstFiles
Section
  SetOutPath $INSTDIR
  File ..\makensis.exe
SectionEnd

Modern user interface[edit]

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.

Plugins[edit]

NSIS can be extended with plugins that can communicate with the installer. Plugins can be written in any managed programming language capable of building a dynamic-link library, 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[edit]

NSIS supports the following features:[3]

Graphical interfaces[edit]

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

Installer interfaces[edit]

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.

Generated installer[edit]

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

The archive may be unpacked using either 7-Zip, the Total Commander plugin "InstallExplorer", or the predecessor by the same name for the FAR Manager.

The archive contains several folders:

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

Unicode support[edit]

The official release of NSIS does not support Unicode but only a means to convert some files to different encodings via a plugin.[5] However, a variant of NSIS that has full Unicode support is available.[6] Notable projects using this variant are:[7]

See also[edit]

References[edit]

External links[edit]