Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-04-06 01:22:21 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-lubosz/INSTALLER.md
Kalila 0693fcbf60
Apply suggestions from code review 
Co-authored-by: Julian Groß  <firedefender1@googlemail.com>
2021-03-01 17:55:09 -05:00

7.1 KiB
Raw Blame History

Creating an Installer

Last Updated on February 21, 2021

Follow the build guide to figure out how to build Vircadia for your platform.

During generation, CMake should produce an install target and a package target.

The install target will copy the Vircadia targets and their dependencies to your CMAKE_INSTALL_PREFIX.
This variable is set by the project(hifi) command in CMakeLists.txt to C:/Program Files/hifi and stored in build/CMakeCache.txt

Packaging

To produce an installer, run the package target. However you will want to follow the steps specific to your platform below.

Windows

Prerequisites

To produce an executable installer on Windows, the following are required:

  1. 7-zip

  2. Nullsoft Scriptable Install System - 3.04
    Install using defaults (will install to C:\Program Files (x86)\NSIS)

  3. UAC Plug-in for Nullsoft - 0.2.4c

    1. Extract Zip
    2. Copy UAC.nsh to C:\Program Files (x86)\NSIS\Include\
    3. Copy Plugins\x86-ansi\UAC.dll to C:\Program Files (x86)\NSIS\Plugins\x86-ansi\
    4. Copy Plugins\x86-unicode\UAC.dll to C:\Program Files (x86)\NSIS\Plugins\x86-unicode\

  4. nsProcess Plug-in for Nullsoft - 1.6 (use the link marked nsProcess_1_6.7z)

    1. Extract Zip
    2. Copy Include\nsProcess.nsh to C:\Program Files (x86)\NSIS\Include\
    3. Copy Plugins\nsProcess.dll to C:\Program Files (x86)\NSIS\Plugins\x86-ansi\
    4. Copy Plugins\nsProcessW.dll to C:\Program Files (x86)\NSIS\Plugins\x86-unicode\

  5. InetC Plug-in for Nullsoft - 1.0

    1. Extract Zip
    2. Copy Plugin\x86-ansi\InetC.dll to C:\Program Files (x86)\NSIS\Plugins\x86-ansi\
    3. Copy Plugin\x86-unicode\InetC.dll to C:\Program Files (x86)\NSIS\Plugins\x86-unicode\

  6. NSISpcre Plug-in for Nullsoft - 1.0

    1. Extract Zip
    2. Copy NSISpre.nsh to C:\Program Files (x86)\NSIS\Include\
    3. Copy NSISpre.dll to C:\Program Files (x86)\NSIS\Plugins\x86-ansi\

  7. nsisSlideshow Plug-in for Nullsoft - 1.7

    1. Extract Zip
    2. Copy bin\nsisSlideshow.dll to C:\Program Files (x86)\NSIS\Plugins\x86-ansi\
    3. Copy bin\nsisSlideshowW.dll to C:\Program Files (x86)\NSIS\Plugins\x86-unicode\

  8. Nsisunz plug-in for Nullsoft

    1. Download both Zips and unzip
    2. Copy nsisunz\Release\nsisunz.dll to C:\Program Files (x86)\NSIS\Plugins\x86-ansi\
    3. Copy NSISunzU\Plugin unicode\nsisunz.dll to C:\Program Files (x86)\NSIS\Plugins\x86-unicode\

  9. ApplicationID plug-in for Nullsoft - 1.0

    1. Download Pre-built DLLs
    2. Extract Zip
    3. Copy Release\ApplicationID.dll to C:\Program Files (x86)\NSIS\Plugins\x86-ansi\
    4. Copy ReleaseUnicode\ApplicationID.dll to C:\Program Files (x86)\NSIS\Plugins\x86-unicode\

  10. Node.JS and NPM

    1. Install version 10.15.0 LTS (or greater)

Code Signing (optional)

For code signing to work, you will need to set the HF_PFX_FILE and HF_PFX_PASSPHRASE environment variables to be present during CMake runtime and globally as we proceed to package the installer.

Creating the Installer

  1. Perform a clean cmake from a new terminal.
  2. Open the vircadia.sln solution with elevated (administrator) permissions on Visual Studio and select the Release configuration.
  3. Build the solution.
  4. Build packaged-server-console-npm-install (found under hidden/Server Console)
  5. Build packaged-server-console (found under Server Console)
    This will add 2 folders to build\server-console\ -
    server-console-win32-x64 and x64
  6. Build CMakeTargets->PACKAGE
    The installer is now available in build\_CPack_Packages\win64\NSIS

FAQ

  1. Problem: Failure to open a file. File: failed opening file "\FOLDERSHARE\XYZSRelease\...\Credits.rtf" Error in script "C:\TFS\XYZProject\Releases\NullsoftInstaller\XYZWin7Installer.nsi" on line 77 -- aborting creation process
    1. Cause: The complete path (current directory + relative path) has to be < 260 characters to any of the relevant files.
    2. Solution: Move your build and packaging folder as high up in the drive as possible to prevent an overage.

OS X

  1. npm Install version 12.16.3 LTS

  2. Perform a clean CMake.

  3. Perform a Release build of ALL_BUILD

  4. Perform a Release build of packaged-server-console This will add a folder to build\server-console\ -
    Sandbox-darwin-x64

  5. Perform a Release build of package Installer is now available in `build/_CPack_Packages/Darwin/DragNDrop

Linux

Server

Ubuntu 18.04 | .deb
  1. Ensure you are using an Ubuntu 18.04 system.
  2. Get and bootstrap Vircadia Builder. 
    git clone https://github.com/vircadia/vircadia-builder.git
cd vircadia-builder
chmod +x vircadia-builder
  3. Run Vircadia Builder to build the server. See here for possible environment variables and settings. 
    ./vircadia-builder --build server
  4. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. 
    ./vircadia-builder --build server
  5. Navigate to the pkg-scripts directory. 
    cd ../Vircadia/source/pkg-scripts/
  6. Generate the .deb package. Set DEBVERSION to a valid semantic version value e.g. "2021.1.0". 
    DEBVERSION="Semver e.g. 2021.1.0" DEBEMAIL="your-email@somewhere.com" DEBFULLNAME="Your Full Name" ./make-deb-server
  7. If successful, the generated .deb package will be in the pkg-scripts folder.
Amazon Linux 2 | .rpm
  1. Ensure you are using an Amazon Linux 2 system.
  2. Update the system and install dependencies. 
    sudo yum update -y
sudo yum install git -y
sudo yum install rpm-build
  3. Get and bootstrap Vircadia Builder. 
    git clone https://github.com/vircadia/vircadia-builder.git
cd vircadia-builder
sudo ./install_amazon_linux_deps.sh
chmod +x vircadia-builder
  4. Run Vircadia Builder to build the server. See here for possible environment variables and settings. 
    ./vircadia-builder --build server
  5. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. 
    ./vircadia-builder --build server
  6. Navigate to the pkg-scripts directory. 
    cd ../Vircadia/source/pkg-scripts/
  7. Generate the .rpm package. Set RPMVERSION to a valid semantic version value e.g. "2021.1.0". 
    RPMVERSION="Semver e.g. 2021.1.0" ./make-rpm-server
  8. If successful, the generated .rpm package will be in the pkg-scripts folder.