SteamFrame/OpenVR-AdvancedSettings-frame
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add new build scripts for windows

Browse Source 
The old build scripts used hard coded directory paths, didn't check if
the paths actually existed and didn't differentiate between compiling,
deploying libraries and packaging for release.

The new build scripts are split into three different files. They are all
longer than the old build scripts, but most of the extra lines are
error checking, which the old one lacked.

It was considered writing the build scripts in another language like
Python or Powershell, but the relatively small size of the project and
unlikelihood of the build systems needing to grow massively means that a
very simple imperative language like the Microsoft scripting language is
fine.
This commit is contained in:
Vasily
2018-12-26 18:10:10 +01:00
parent 835c51e937
commit 8bec43d01e
3 changed files with 294 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
build_scripts/win/build_windows.cmd
+105
View File
@@ -0,0 +1,105 @@
@echo off
REM Echo off to avoid spam.
REM Non zero is failure, 0 is success.
SET exit_code_success=0
SET exit_code_failure_build_apps=1
SET exit_code_failure_build_locations=2
REM Used for echos.
SET current_activity=BUILD
REM If scripts are chain called the original dirs should not be overwritten.
IF NOT DEFINED original_dir (
SET original_dir=%CD%
)
IF NOT DEFINED project_dir (
REM Arg 0 (called %0) is the full path to the file.
REM https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/call#batch-parameters
REM As per above link, %~dp0 expands the zeroth arg to a drive letter and path only.
SET folder_path=%~dp0
REM Project dir is up two dirs from the file.
SET project_dir=%folder_path%\..\..\
)
REM Change dir to the project dir, otherwise qmake doesn't know where it is.
CD %project_dir%
ECHO %current_activity%: Testing if all required build environment values are set:
IF NOT DEFINED QT_LOC (
ECHO %current_activity%: QT_LOC not defined. Using default value.
SET QT_LOC="C:\Qt\5.11.1\msvc2017_64\bin\"
)
ECHO %current_activity%: QT_LOC set to '%QT_LOC%'.
IF EXIST %QT_LOC% (
ECHO %current_activity%: QT_LOC exists.
) ELSE (
ECHO %current_activity%: QT_LOC directory does not exist. Exiting.
EXIT /B %exit_code_failure_build_locations%
)
IF NOT DEFINED VS_LOC (
ECHO %current_activity%: VS_LOC not defined. Using default value.
SET VS_LOC="C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat"
)
ECHO %current_activity%: VS_LOC set to '%VS_LOC%'.
IF EXIST %VS_LOC% (
ECHO %current_activity%: VS_LOC exists.
) ELSE (
ECHO %current_activity%: VS_LOC directory does not exist. Exiting.
EXIT /B %exit_code_failure_build_locations%
)
ECHO %current_activity%: All required build environment values are set.
IF DEFINED BUILD_DEBUG (
ECHO %current_activity%: BUILD_DEBUG var set. Compiling for debug.
SET compile_level=debug
) ELSE (
ECHO %current_activity%: BUILD_DEBUG var not set. Compiling for release.
SET compile_level=release
)
ECHO %current_activity%: Setting up environment with Visual Studio 'vcvarsall.bat'.
REM Currently only this platform is supported.
SET target_platform=AMD64
REM Set up environment for qmake.
CALL %VS_LOC% %target_platform%
IF DEFINED BUILD_VSPROJ (
ECHO %current_activity%: BUILD_VSPROJ defined. Building Visual Studio project files.
%QT_LOC%\qmake -tp vc
ECHO %current_activity%: Building Visual Studio project files done.
) ELSE (
ECHO %current_activity%: BUILD_VSPROJ not defined. Not building Visual Studio project files.
)
ECHO %current_activity%: Running qmake for %compile_level%:
%QT_LOC%\qmake -spec win32-msvc CONFIG+=x86_64 CONFIG+=%compile_level%
ECHO %current_activity%: qmake done.
IF NOT DEFINED JOM_LOC (
ECHO %current_activity%: JOM_LOC not defined. Using default value.
SET JOM_LOC="C:\Qt\Tools\QtCreator\bin\jom.exe"
)
ECHO %current_activity%: JOM_LOC set to '%JOM_LOC%'.
IF EXIST %JOM_LOC% (
ECHO %current_activity%: JOM_LOC exists.
ECHO %current_activity%: Running jom:
%JOM_LOC%
REM jom will not exit with an error code. Leading to a passing build even with errors.
IF ERRORLEVEL 1 EXIT /B %exit_code_failure_build_apps%
ECHO %current_activity%: jom done.
) ELSE (
ECHO JOM_LOC directory does not exist. Using nmake.
ECHO %current_activity%: Running nmake:
nmake
REM nmake will not exit with an error code. Leading to a passing build even with errors.
IF ERRORLEVEL 1 EXIT /B %exit_code_failure_build_apps%
ECHO %current_activity%: nmake done.
)
CD %original_dir%
ECHO %current_activity%: %current_activity% DONE.
build_scripts/win/deploy_windows.cmd
+119
View File
@@ -0,0 +1,119 @@
@echo off
REM Echo off to avoid spam.
REM Non zero is failure, 0 is success.
SET exit_code_success=0
SET exit_code_failure_build_apps=1
SET exit_code_failure_build_locations=2
SET output_dir="\bin\win64\"
REM Used for echos.
SET current_activity=DEPLOY
REM If scripts are chain called the original dirs should not be overwritten.
IF NOT DEFINED original_dir (
SET original_dir=%CD%
)
IF NOT DEFINED project_dir (
REM Arg 0 (called %0) is the full path to the file.
REM https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/call#batch-parameters
REM As per above link, %~dp0 expands the zeroth arg to a drive letter and path only.
SET folder_path=%~dp0
REM Project dir is up two dirs from the file.
SET project_dir=%folder_path%\..\..\
)
ECHO %current_activity%: Testing if all required build environment values are set:
IF NOT DEFINED QT_LOC (
ECHO %current_activity%: QT_LOC not defined. Using default value.
SET QT_LOC="C:\Qt\5.11.1\msvc2017_64\bin\"
)
ECHO %current_activity%: QT_LOC set to '%QT_LOC%'.
IF EXIST %QT_LOC% (
ECHO %current_activity%: QT_LOC exists.
) ELSE (
ECHO %current_activity%: QT_LOC directory does not exist. Exiting.
EXIT /B %exit_code_failure_build_locations%
)
ECHO %current_activity%: All required build environment values are set.
IF NOT EXIST %project_dir%\%output_dir% (
ECHO %current_activity%: Output dir '%output_dir%' does not exist. Creating.
mkdir %project_dir%\%output_dir%
ECHO %current_activity%: Output dir created.
)
cd %project_dir%\%output_dir%
IF DEFINED BUILD_DEBUG (
ECHO %current_activity%: BUILD_DEBUG var set. Compiling for debug.
SET compile_level=debug
) ELSE (
ECHO %current_activity%: BUILD_DEBUG var not set. Compiling for release.
SET compile_level=release
)
ECHO %current_activity%: Running windeployqt:
REM windeployqt requires the QT\bin location to be in the path.
REM Changing the PATH var is not ideal, but windeployqt does not work otherwise.
set original_path=%PATH%
set PATH=%QT_LOC%;%PATH%
REM Caret newline (^CFLR) splits a command over several lines.
REM This is done to avoid one ultra long line.
windeployqt --dir AdvancedSettings\qtdata ^
--libdir AdvancedSettings ^
--plugindir AdvancedSettings\qtdata\plugins ^
--no-system-d3d-compiler ^
--no-opengl-sw ^
--%compile_level% ^
--qmldir ..\..\src\res\qml\ ^
AdvancedSettings\AdvancedSettings.exe
REM windeployqt does not exit on error by itself.
IF ERRORLEVEL 1 EXIT /B %exit_code_failure_build_apps%
REM Return the PATH to original as quickly as possible.
set PATH=%original_path%
ECHO %current_activity%: windeployqt done.
REM Switches used for copy:
REM /V Verifies that files have been copied correctly.
REM /Q Suppresses xcopy spam.
REM /Y Skips the overwrite yes prompt.
REM /E Copies all subdirs, even if they are empty.
REM /I "If Source is a directory or contains wildcards and Destination does not exist,
REM xcopy assumes Destination specifies a directory name and creates a new directory.
REM Then, xcopy copies all specified files into the new directory. By default,
REM xcopy prompts you to specify whether Destination is a file or a directory."
ECHO %current_activity%: Copying necessary files.
copy /V /Y "%project_dir%\Readme.md" "%project_dir%\%output_dir%\AdvancedSettings\Readme.md"
ECHO %current_activity%: README copied.
REM All three licenses must be included in binary releases, as per the terms.
copy /V /Y "%project_dir%\LICENSE" "%project_dir%\%output_dir%\AdvancedSettings\LICENSE-GPL.txt"
copy /V /Y "%project_dir%\third-party\openvr\LICENSE" "%project_dir%\%output_dir%\AdvancedSettings\LICENSE-VALVE.txt"
copy /V /Y "%project_dir%\third-party\easylogging++\LICENSE" "%project_dir%\%output_dir%\AdvancedSettings\LICENSE-MIT.txt"
ECHO %current_activity%: LICENSE files copied.
xcopy /Q /Y /E /I /V "%project_dir%\src\res" "%project_dir%\%output_dir%\AdvancedSettings\res\"
ECHO %current_activity%: Resource files copied.
copy /V /Y "%project_dir%\src\restartvrserver.bat" "%project_dir%\%output_dir%\AdvancedSettings\restartvrserver.bat"
copy /V /Y "%project_dir%\src\startdesktopmode.bat" "%project_dir%\%output_dir%\AdvancedSettings\startdesktopmode.bat"
ECHO %current_activity%: Extra batch files copied.
copy /V /Y "%project_dir%\src\qt.conf" "%project_dir%\%output_dir%\AdvancedSettings\qt.conf"
copy /V /Y "%project_dir%\src\manifest.vrmanifest" "%project_dir%\%output_dir%\AdvancedSettings\manifest.vrmanifest"
ECHO %current_activity%: VR specific configuration files copied.
copy /V /Y "%project_dir%\third-party\openvr\bin\win64\openvr_api.dll" "%project_dir%\%output_dir%\AdvancedSettings\openvr_api.dll"
ECHO %current_activity%: OpenVR .dll copied.
cd %original_dir%
ECHO %current_activity%: %current_activity% DONE.
build_scripts/win/package_windows.cmd
+70
View File
@@ -0,0 +1,70 @@
@echo off
REM Echo off to avoid spam.
REM Non zero is failure, 0 is success.
SET exit_code_success=0
SET exit_code_failure_build_apps=1
SET exit_code_failure_build_locations=2
SET output_dir="\bin\win64\"
REM Used for echos.
SET current_activity=PACKAGE
REM If scripts are chain called the original dirs should not be overwritten.
IF NOT DEFINED original_dir (
SET original_dir=%CD%
)
IF NOT DEFINED project_dir (
REM Arg 0 (called %0) is the full path to the file.
REM https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/call#batch-parameters
REM As per above link, %~dp0 expands the zeroth arg to a drive letter and path only.
SET folder_path=%~dp0
REM Project dir is up two dirs from the file.
SET project_dir=%folder_path%\..\..\
)
REM ZIP_LOC can't be called 7Z_LOC because of Windows limitations.
ECHO %current_activity%: Testing if all required build environment values are set:
IF NOT DEFINED ZIP_LOC (
ECHO %current_activity%: ZIP_LOC not defined. Using default value.
SET ZIP_LOC="C:\Program Files\7-Zip\7z.exe"
)
ECHO %current_activity%: ZIP_LOC set to '%ZIP_LOC%'.
IF EXIST %ZIP_LOC% (
ECHO %current_activity%: ZIP_LOC exists.
) ELSE (
ECHO %current_activity%: ZIP_LOC directory does not exist. Exiting.
EXIT /B %exit_code_failure_build_locations%
)
ECHO %current_activity%: Testing if all required build environment values are set:
IF NOT DEFINED NSIS_LOC (
ECHO %current_activity%: NSIS_LOC not defined. Using default value.
SET NSIS_LOC="C:\Program Files (x86)\NSIS\"
)
ECHO %current_activity%: NSIS_LOC set to '%NSIS_LOC%'.
IF EXIST %NSIS_LOC% (
ECHO %current_activity%: NSIS_LOC exists.
) ELSE (
ECHO %current_activity%: NSIS_LOC directory does not exist. Exiting.
EXIT /B %exit_code_failure_build_locations%
)
ECHO %current_activity%: All required build environment values are set.
ECHO %current_activity%: Running 7zip:
%ZIP_LOC% a %project_dir%\%output_dir%\AdvancedSettings.zip %project_dir%\%output_dir%\AdvancedSettings\*
ECHO %current_activity%: 7zip done.
ECHO %current_activity%: Running NSIS:
REM Trying to launch makensis without CD into the dir does not work for some reason.
CD %NSIS_LOC%
REM /V2 is show warnings and errors, /WX is treat warnings as errors.
makensis /V2 /WX %project_dir%\installer\installer.nsi
IF ERRORLEVEL 1 EXIT /B %exit_code_failure_build_apps%
ECHO %current_activity%: NSIS done.
CD %original_dir%
ECHO %current_activity%: %current_activity% DONE.