Knowledge Base‎ > ‎

Building from Source on Windows

Steps in this color are only relevant if you plan to actively work on the viewer source

Preparation

Install the prerequisite libraries:
CMake (Win32 Installer) (Select to Add To Path)
Python 2.7 (Enable the feature "Add python.exe to Path")
Visual Studio 2015 (Community) (C++) (Select to install the Windows 10 SDK)
NSIS (Unicode) + StdUtils (zip) (Only if you plan to package for distribution) 
Extract StdUtils and move the Include directory into your NSIS Unicode install
and move Plugins\Plugins_Unicode\StdUtils.dll to the plugins directory of your NSIS Unicode install

Open a command prompt (start->run, cmd), run
pip install "hg+https://bitbucket.org/alchemyviewer/autobuild-alchemy"
git clone git://github.com/singularity-viewer/SingularityViewer.git singularity

Generating the project

Open a command prompt (start->run, cmd) and run the following, use -DPACKAGE:BOOL=OFF (speed w/o package)
to build 64-bit use -pwindows64, otherwise you can add -DUSE_QUICKTIME_PREBUILT:BOOL=ON for quicktime
cd %USERPROFILE%\singularity
autobuild configure -cRelease -pwindows -- -DFMODSTUDIO:BOOL=ON -DPACKAGE:BOOL=ON

Open the project in VS2015 by running the following
build-vc140\Singularity.sln

Build->Build Solution to begin the compile process.

The installer and application executables may be found by navigating to the following location from a file explorer (My Computer):
%USERPROFILE%\singularity\build-vc140\newview\Release

Updating

(Be sure to also keep your libraries up to date, return to the NSIS and StdUtils links every so often to check for updates.)

The following is done in a command prompt (start->run, cmd) and assumes you've run
cd %USERPROFILE%\singularity
You can check if we have updated the code by running
git fetch
this will give output if there are changes, if so update your local files by running
git pull
Finally, compile again to update your build.