ExperienceUI Documentation Content Frame

Skin the entire installer

+ + + + The ExperienceUI includes support for WAnsis, Saivert's skinning plugin. WAnsis is a plugin for NSIS that uses Winamp + 2 skins to change the look of the installer completely. The ExperienceUI natively supports WAnsis, and it is very easy to + implement it into your script.
+
+ NOTES: WAnsis support adds 22KB of overhead to the installer, and the plugin can sometimes be unstable. If you are + very concerned about size, or do not want to take risks concerning stability, you may want to leave WAnsis support out of the + installer. + + + +

WAnsis Settings

+ +

XPUI_WANSIS

Define this to turn on all WAnsis support in the ExperienceUI. WAnsis has been known to be unstable, so please test your installer thoroughly before you distribute it. (Default: by default, XPUI_WANSIS is undefined)

XPUI_WANSIS_SKIN Skin_folder_name

Sets the WAnsis skin to Skin_folder_name, where Skin_folder_name is a folder inside the ExperienceUI's skin directory. (<NSIS>\Contrib\ExperienceUI\Skins) If you plan to make WAnsis skins, it is different that making standard skins. Please see the guide below. (Default: "Forum")

XPUI_WANSIS_HEADERIMAGE

Define this to use a header image in your WAnsis-enabled installer. If you don't define this, the installer's icon will appear in the spot where the header image would go. (Default: not defined)

XPUI_WANSIS_HEADERIMAGE_BMP BMP_file

Uses BMP_file as the header bitmap in a WAnsis installer. Recommended size: 150x57px. (Default: <NSIS>\Contrib\ExperienceUI\Skins\<WAnsis skin>\Header.bmp)

XPUI_WANSIS_UI UI_file

Uses UI_file as the UI for a WAnsis-enabled installer. Don't change this unless you really know what you are doing. (Default: <NSIS>\Contrib\ExperienceUI\UIs\WAnsis_ui.exe)

XPUI_WANSIS_GEN BMP_file

The "gen" bitmap used for WAnsis. Please refer to the WAnsis documentation and the Winamp Skinners' Guide for help on creating WAnsis skins. (Default: <NSIS>\Contrib\ExperienceUI\Skins\<WAnsis skin>\gen.bmp)

XPUI_WANSIS_GENEX BMP_file

The "genex" bitmap used for WAnsis. Please refer to the WAnsis documentation and the Winamp Skinners' Guide for help on creating WAnsis skins. (Default: <NSIS>\Contrib\ExperienceUI\Skins\<WAnsis skin>\genex.bmp)

+ +

+ + To change the Bottom Image and the Left Logo, use XPUI_BOTTOMIMAGE_BMP and XPUI_LEFTLOGO, respectively. See this page for more information. + +

+ +

Creating WAnsis Skins

+ + + + You can created your own WAnsis skins, too. The WAnsis skinning system is a little bit more limited than the standard + skinning system, but it makes skin initialization faster and it means you don't need any scripting knowledge to make WAnsis + skins.
+
+ The ExperienceUI WAnsis skinning system has 5 mandatory bitmaps and 1 optional bitmap. A description of each bitmap can be + found below:
+ + + +

bottom.bmp – The bottom image. The best size is 693x70px, but the last two columns to the right are cut off. I'm still trying to figure this one out.

checks.bmp – The checkbox images used on the Components page.

gen.bmp – The bitmap containing window border elements. See the WAnsis documentation for more information.

genex.bmp – The buttons, scrollbars, and color tables for the interior of the window. Again, see the WAnsis doumentation for more information.

header.bmp – Optional Modern UI-compatible header bitmap. Will only be used if XPUI_WANSIS_HEADERIMAGE is defined. If you don't include this and the user of the skin defines XPUI_WANSIS_HEADERIMAGE, MakeNSIS will halt.

leftlogo.bmp – The image shown on the left of the installer window. Recommended size is 240x349px.

+ + + + To create a new WAnsis skin, navigate to the <NSIS>\Contrib\ExperienceUI\Skins folder and create a new directory. Name + the directory whatever you want your skin's screen name to be.
+
+ Next, put the bitmap files listed above in the folder you just made.
+
+ Last, test your skin by using compiling following script:
+ +

+ +

+!define XPUI_WANSIS
+!define XPUI_WANSIS_SKIN "<Skin name>"
+!include XPUI.nsh
+!insertmacro XPUI_PAGE_WELCOME2
+!insertmacro XPUI_PAGE_LICENSE "${NSISDIR}\Contrib\ExperienceUI\License.rtf"
+!insertmacro XPUI_PAGE_COMPONENTS
+!insertmacro XPUI_PAGE_DIRECTORY
+!insertmacro XPUI_PAGE_INSTCONFIRM
+!insertmacro XPUI_PAGE_INSTFILES
+!insertmacro XPUI_PAGE_FINISH
+!insertmacro XPUI_PAGE_ABORT
+!define XPUI_ABORTWARNING
+!insertmacro XPUI_LANGUAGE English
+
+Name "Testing: ExperienceUI WAnsis Skin ${XPUI_WANSIS_SKIN}"
+Caption "Testing: ExperienceUI WAnsis Skin ${XPUI_WANSIS_SKIN}"
+OutFile "${XPUI_WANSIS_SKIN} Test.exe"
+
+InstallDir C:\Test
+
+Section
+SectionEnd
+
+

+ +

+ + Be sure to replace "<Skin name>" with the name of the folder you created. + +