Fixes for compilation on Windows for x86

#689

.github/actions/vulkan/action.yml

@@ -0,0 +1,39 @@
+name: Install Vulkan SDK
+description: Downloads and installs Vulkan SDK.
+inputs:
+  vulkan-version:
+    description: 'Vulkan SDK release version (e.g. 1.2.198.1).'
+    default: '1.2.198.1'
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - name: Install Vulkan SDK
+      shell: bash
+      run: |
+        export VULKAN_SDK_VER=${{ inputs.vulkan-version }}
+        echo VULKAN_SDK_VER=$VULKAN_SDK_VER >> $GITHUB_ENV
+        echo "Downloading Vulkan SDK version $VULKAN_SDK_VER"
+        case `uname -s` in
+          Linux)
+            export VULKAN_SDK_ROOT=`pwd`/../VulkanSDK
+            wget "https://sdk.lunarg.com/sdk/download/$VULKAN_SDK_VER/linux/vulkan-sdk.tar.gz" --no-verbose -O vulkan-sdk.tar.gz
+            mkdir $VULKAN_SDK_ROOT
+            tar -xf vulkan-sdk.tar.gz -C $VULKAN_SDK_ROOT
+            export VULKAN_SDK=$VULKAN_SDK_ROOT/$VULKAN_SDK_VER/x86_64
+            ;;
+          Darwin)
+            export VULKAN_SDK_ROOT=`pwd`/../VulkanSDK
+            curl -LO "https://sdk.lunarg.com/sdk/download/$VULKAN_SDK_VER/mac/vulkan-sdk.dmg"
+            hdiutil attach vulkan-sdk.dmg -mountpoint /Volumes/vulkan-sdk
+            sudo "/Volumes/vulkan-sdk/InstallVulkan.app/Contents/MacOS/InstallVulkan" --root $VULKAN_SDK_ROOT --accept-licenses --default-answer --confirm-command install
+            export VULKAN_SDK=$VULKAN_SDK_ROOT/macOS
+            ;;
+          *) # Windows
+            curl -L -o vulkan-sdk.exe https://sdk.lunarg.com/sdk/download/$VULKAN_SDK_VER/windows/VulkanSDK-$VULKAN_SDK_VER-Installer.exe
+            ./vulkan-sdk.exe --root "C:\VulkanSDK"  --accept-licenses --default-answer --confirm-command install
+            export VULKAN_SDK="C:\VulkanSDK"
+            ;;
+        esac
+        echo VULKAN_SDK=$VULKAN_SDK >> $GITHUB_ENV
+        echo "Vulkan SDK installed to $VULKAN_SDK"

.github/workflows/build_linux.yml

@@ -10,16 +10,18 @@ jobs:
     steps:
     - name: Checkout repo
       uses: actions/checkout@v2
-    - name: Checkout LFS
-      run: |
-        git lfs version
-        git lfs pull
     - name: Install dependencies
       run: |
         sudo rm -f /etc/apt/sources.list.d/*
         sudo cp -f .github/workflows/build_linux_sources.list /etc/apt/sources.list
         sudo apt-get update
         sudo apt-get install libx11-dev libxcursor-dev libxinerama-dev build-essential gettext libtool libtool-bin libpulse-dev libasound2-dev libjack-dev portaudio19-dev
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
+    - name: Checkout LFS
+      run: |
+        git lfs version
+        git lfs pull
     - name: Build
       run: |
         ./Development/Scripts/Linux/CallBuildTool.sh -build -log -arch=x64 -platform=Linux -configuration=Development -buildtargets=FlaxEditor
@@ -29,11 +31,13 @@ jobs:
     name: Game (Linux, Release x64)
     runs-on: "ubuntu-20.04"
     steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
     - name: Install dependencies
       run: |
         sudo apt-get install libx11-dev libxcursor-dev libxinerama-dev
-    - name: Checkout repo
+    - name: Setup Vulkan
-      uses: actions/checkout@v2
+      uses: ./.github/actions/vulkan
     - name: Checkout LFS
       run: |
         git lfs version

.github/workflows/build_mac.yml

@@ -0,0 +1,38 @@
+name: Build macOS
+on: [push, pull_request]
+
+jobs:
+
+  # Editor
+  editor-mac:
+    name: Editor (Mac, Development x64)
+    runs-on: "macos-latest"
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
+    - name: Checkout LFS
+      run: |
+        git lfs version
+        git lfs pull
+    - name: Build
+      run: |
+        ./Development/Scripts/Mac/CallBuildTool.sh -build -log -arch=x64 -platform=Mac -configuration=Development -buildtargets=FlaxEditor
+
+  # Game
+  game-mac:
+    name: Game (Mac, Release x64)
+    runs-on: "macos-latest"
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
+    - name: Checkout LFS
+      run: |
+        git lfs version
+        git lfs pull
+    - name: Build
+      run: |
+        ./Development/Scripts/Mac/CallBuildTool.sh -build -log -arch=x64 -platform=Mac -configuration=Release -buildtargets=FlaxGame

.github/workflows/build_windows.yml

@@ -6,10 +6,12 @@ jobs:
   # Editor
   editor-windows:
     name: Editor (Windows, Development x64)
-    runs-on: "windows-latest"
+    runs-on: "windows-2019"
     steps:
     - name: Checkout repo
       uses: actions/checkout@v2
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
     - name: Checkout LFS
       run: |
         git lfs version
@@ -21,10 +23,12 @@ jobs:
   # Game
   game-windows:
     name: Game (Windows, Release x64)
-    runs-on: "windows-latest"
+    runs-on: "windows-2019"
     steps:
     - name: Checkout repo
       uses: actions/checkout@v2
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
     - name: Checkout LFS
       run: |
         git lfs version

.github/workflows/cd.yml

@@ -9,7 +9,7 @@ jobs:
   # Windows
   package-windows-editor:
     name: Editor (Windows)
-    runs-on: "windows-latest"
+    runs-on: "windows-2019"
     steps:
     - name: Checkout repo
       uses: actions/checkout@v2
@@ -17,6 +17,8 @@ jobs:
       run: |
         git lfs version
         git lfs pull
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
     - name: Build
       run: |
         .\PackageEditor.bat -arch=x64 -platform=Windows -deployOutput=Output
@@ -32,7 +34,7 @@ jobs:
         path: Output/EditorDebugSymbols.zip
   package-windows-game:
     name: Game (Windows)
-    runs-on: "windows-latest"
+    runs-on: "windows-2019"
     steps:
     - name: Checkout repo
       uses: actions/checkout@v2
@@ -40,6 +42,8 @@ jobs:
       run: |
         git lfs version
         git lfs pull
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
     - name: Build
       run: |
         .\PackagePlatforms.bat -arch=x64 -platform=Windows -deployOutput=Output
@@ -66,6 +70,8 @@ jobs:
         sudo cp -f .github/workflows/build_linux_sources.list /etc/apt/sources.list
         sudo apt-get update
         sudo apt-get install libx11-dev libxcursor-dev libxinerama-dev build-essential gettext libtool libtool-bin libpulse-dev libasound2-dev libjack-dev portaudio19-dev
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
     - name: Build
       run: |
         ./PackageEditor.sh -arch=x64 -platform=Linux -deployOutput=Output
@@ -90,6 +96,8 @@ jobs:
         sudo cp -f .github/workflows/build_linux_sources.list /etc/apt/sources.list
         sudo apt-get update
         sudo apt-get install libx11-dev libxcursor-dev libxinerama-dev build-essential gettext libtool libtool-bin libpulse-dev libasound2-dev libjack-dev portaudio19-dev
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
     - name: Build
       run: |
         ./PackagePlatforms.sh -arch=x64 -platform=Linux -deployOutput=Output
@@ -98,3 +106,45 @@ jobs:
       with:
         name: Linux-Game
         path: Output/Linux.zip
+
+  # Mac
+  package-mac-editor:
+    name: Editor (Mac)
+    runs-on: "macos-latest"
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+    - name: Checkout LFS
+      run: |
+        git lfs version
+        git lfs pull
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
+    - name: Build
+      run: |
+        ./PackageEditor.command -arch=x64 -platform=Mac -deployOutput=Output
+    - name: Upload
+      uses: actions/upload-artifact@v2
+      with:
+        name: Mac-Editor
+        path: Output/FlaxEditorMac.zip
+  package-mac-game:
+    name: Game (Mac)
+    runs-on: "macos-latest"
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+    - name: Checkout LFS
+      run: |
+        git lfs version
+        git lfs pull
+    - name: Setup Vulkan
+      uses: ./.github/actions/vulkan
+    - name: Build
+      run: |
+        ./PackagePlatforms.command -arch=x64 -platform=Mac -deployOutput=Output
+    - name: Upload
+      uses: actions/upload-artifact@v2
+      with:
+        name: Mac-Game
+        path: Output/Mac.zip

.github/workflows/tests.yml

@@ -0,0 +1,34 @@
+name: Tests
+on: [push, pull_request]
+
+jobs:
+
+  # Tests
+  tests-linux:
+    name: Tests (Linux)
+    runs-on: "ubuntu-20.04"
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v2
+    - name: Checkout LFS
+      run: |
+        git lfs version
+        git lfs pull
+    - name: Install dependencies
+      run: |
+        sudo rm -f /etc/apt/sources.list.d/*
+        sudo cp -f .github/workflows/build_linux_sources.list /etc/apt/sources.list
+        sudo apt-get update
+        sudo apt-get install libx11-dev libxcursor-dev libxinerama-dev build-essential gettext libtool libtool-bin libpulse-dev libasound2-dev libjack-dev portaudio19-dev
+    - name: Build
+      run: |
+        ./GenerateProjectFiles.sh -vs2019
+        ./Development/Scripts/Linux/CallBuildTool.sh -build -log -arch=x64 -platform=Linux -configuration=Development -buildtargets=FlaxTestsTarget
+        ./Development/Scripts/Linux/CallBuildTool.sh -build -log -arch=x64 -platform=Linux -configuration=Debug -buildtargets=FlaxEditor -BuildBindingsOnly
+        ./Development/Scripts/Linux/CallBuildTool.sh -build -log -arch=x64 -platform=Linux -configuration=Debug -buildtargets="FlaxEngine.Tests"
+        ./Development/Scripts/Linux/CallBuildTool.sh -build -log -arch=x64 -platform=Linux -configuration=Debug -buildtargets="Flax.Build.Tests"
+    - name: Test
+      run: |
+        Binaries/Tests/Linux/x64/Development/FlaxTests
+        mono Source/Platforms/DotNet/NUnit/nunit3-console.exe Binaries/Tools/FlaxEngine.Tests.dll --framework=mono-4.0
+        mono Source/Platforms/DotNet/NUnit/nunit3-console.exe Binaries/Tools/Flax.Build.Tests.dll --framework=mono-4.0

.gitignore

@@ -19,6 +19,8 @@ Source/*.csproj
 *.tlog
 *.lastbuilddate
 *.opendb
+*.DS_Store
+*.xcodeproj
 
 # NUNIT
 *.VisualState.xml

CODE_OF_CONDUCT.md

@@ -38,6 +38,12 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 
+## Contribution
+
+Using Flax source code is strictly governed by the Flax Engine End User License Agreement. If you don't agree to those terms, as amended from time to time, you are not permitted to access or use Flax Engine.
+
+We welcome any contributions to Flax Engine development through pull requests on GitHub. Most of our active development is in the master branch, so we prefer to take pull requests there (particularly for new features). We try to make sure that all new code adheres to the Flax coding standards. All contributions are governed by the terms of the [EULA](https://flaxengine.com/licensing/).
+
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

Content/Editor/MaterialTemplates/Deformable.shader

@@ -374,4 +374,18 @@ void PS_Depth(PixelInput input)
 #endif
 }
 
+#if _PS_QuadOverdraw
+
+#include "./Flax/Editor/QuadOverdraw.hlsl"
+
+// Pixel Shader function for Quad Overdraw Pass (editor-only)
+[earlydepthstencil]
+META_PS(USE_EDITOR, FEATURE_LEVEL_SM5)
+void PS_QuadOverdraw(float4 svPos : SV_Position, uint primId : SV_PrimitiveID)
+{
+	DoQuadOverdraw(svPos, primId);
+}
+
+#endif
+
 @9

Content/Editor/MaterialTemplates/Particle.shader

@@ -694,4 +694,18 @@ void PS_Depth(PixelInput input)
 #endif
 }
 
+#if _PS_QuadOverdraw
+
+#include "./Flax/Editor/QuadOverdraw.hlsl"
+
+// Pixel Shader function for Quad Overdraw Pass (editor-only)
+[earlydepthstencil]
+META_PS(USE_EDITOR, FEATURE_LEVEL_SM5)
+void PS_QuadOverdraw(float4 svPos : SV_Position, uint primId : SV_PrimitiveID)
+{
+	DoQuadOverdraw(svPos, primId);
+}
+
+#endif
+
 @9

Content/Editor/MaterialTemplates/Surface.shader

@@ -594,7 +594,7 @@ void ClipLODTransition(PixelInput input)
 // Pixel Shader function for Depth Pass
 META_PS(true, FEATURE_LEVEL_ES2)
 void PS_Depth(PixelInput input)
-{	
+{
 #if USE_DITHERED_LOD_TRANSITION
 	// LOD masking
 	ClipLODTransition(input);
@@ -615,4 +615,18 @@ void PS_Depth(PixelInput input)
 #endif
 }
 
+#if _PS_QuadOverdraw
+
+#include "./Flax/Editor/QuadOverdraw.hlsl"
+
+// Pixel Shader function for Quad Overdraw Pass (editor-only)
+[earlydepthstencil]
+META_PS(USE_EDITOR, FEATURE_LEVEL_SM5)
+void PS_QuadOverdraw(float4 svPos : SV_Position, uint primId : SV_PrimitiveID)
+{
+	DoQuadOverdraw(svPos, primId);
+}
+
+#endif
+
 @9

Content/Editor/MaterialTemplates/Terrain.shader

@@ -458,4 +458,18 @@ void PS_Depth(PixelInput input)
 #endif
 }
 
+#if _PS_QuadOverdraw
+
+#include "./Flax/Editor/QuadOverdraw.hlsl"
+
+// Pixel Shader function for Quad Overdraw Pass (editor-only)
+[earlydepthstencil]
+META_PS(USE_EDITOR, FEATURE_LEVEL_SM5)
+void PS_QuadOverdraw(float4 svPos : SV_Position, uint primId : SV_PrimitiveID)
+{
+	DoQuadOverdraw(svPos, primId);
+}
+
+#endif
+
 @9

Development/Scripts/Linux/CallBuildTool.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+# Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 set -e
 

Development/Scripts/Mac/CallBuildTool.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+# Copyright (c) 2012-2022 Wojciech Figat. All rights reserved
+
+set -e
+
+testfilesize=$(wc -c < 'Source/Logo.png')
+if [ $testfilesize -le 1000 ]; then
+    echo "CallBuildTool ERROR: Repository was not cloned using Git LFS" 1>&2
+	exit 1
+fi
+
+# Compile the build tool.
+xbuild /nologo /verbosity:quiet "Source/Tools/Flax.Build/Flax.Build.csproj" /property:Configuration=Release /property:Platform=AnyCPU /target:Build
+
+# Run the build tool using the provided arguments.
+#mono --debug --debugger-agent=transport=dt_socket,server=y,address=127.0.0.1:55555 Binaries/Tools/Flax.Build.exe "$@"
+mono Binaries/Tools/Flax.Build.exe "$@"

Development/Scripts/Mac/XCodeBuild.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+# Copyright (c) 2012-2022 Wojciech Figat. All rights reserved
+
+# Fix mono bin to be in a path
+export PATH=/Library/Frameworks/Mono.framework/Versions/Current/Commands:$PATH
+
+echo "Running Flax.Build $*"
+mono Binaries/Tools/Flax.Build.exe "$@"

Development/Scripts/Windows/CallBuildTool.bat

@@ -1,6 +1,6 @@
 @echo off
 
-rem Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+rem Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 if not exist "Development\Scripts\Windows\GetMSBuildPath.bat" goto Error_InvalidLocation
 

Development/Scripts/Windows/GetMSBuildPath.bat

@@ -1,6 +1,6 @@
 @echo off
 
-rem Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+rem Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 set MSBUILD_PATH=
 

Flax.flaxproj

@@ -2,11 +2,11 @@
   "Name": "Flax",
   "Version": {
     "Major": 1,
-    "Minor": 2,
+    "Minor": 3,
-    "Build": 6224
+    "Build": 6228
   },
   "Company": "Flax",
-  "Copyright": "Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.",
+  "Copyright": "Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.",
   "GameTarget": "FlaxGame",
   "EditorTarget": "FlaxEditor"
 }

Flax.sln.DotSettings

@@ -294,6 +294,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=mipmaps/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Mordor/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=MSAA/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=multiplayer/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Multisample/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=multisampled/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=multisampling/@EntryIndexedValue">True</s:Boolean>
@@ -306,6 +307,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=phong/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=preload/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=quat/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Ragdoll/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=rasterization/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Rasterize/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Rasterizer/@EntryIndexedValue">True</s:Boolean>

GenerateProjectFiles.bat

@@ -1,6 +1,6 @@
 @echo off
 
-rem Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+rem Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 setlocal
 pushd

GenerateProjectFiles.command

@@ -0,0 +1,12 @@
+#!/bin/sh
+# Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
+
+set -e
+
+echo Generating Flax Engine project files...
+
+# Change the path to the script root
+cd "`dirname "$0"`"
+
+# Run Flax.Build to generate project files (also pass the arguments)
+bash ./Development/Scripts/Mac/CallBuildTool.sh --genproject "$@"

GenerateProjectFiles.sh

@@ -1,5 +1,5 @@
 #!/bin/sh
-# Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+# Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 set -e
 

ISSUE_TEMPLATE.md

@@ -4,7 +4,7 @@ https://github.com/flaxengine/FlaxEngine/issues?q=is%3Aissue
 
 **Issue description:**
 <!-- What happened, and what was expected. -->
-
+<!-- Log file, can be found in the project directory's `Logs` folder (optional) -->
 
 **Steps to reproduce:**
 <!-- Enter minimal reproduction steps if available. -->

PackageAll.bat

@@ -1,6 +1,6 @@
 @echo off
 
-rem Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+rem Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 setlocal
 pushd

PackageEditor.bat

@@ -1,6 +1,6 @@
 @echo off
 
-rem Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+rem Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 setlocal
 pushd

PackageEditor.command

@@ -0,0 +1,12 @@
+#!/bin/sh
+# Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
+
+set -e
+
+echo Building and packaging Flax Editor...
+
+# Change the path to the script root
+cd "`dirname "$0"`"
+
+# Run Flax.Build (also pass the arguments)
+bash ./Development/Scripts/Mac/CallBuildTool.sh --deploy --deployEditor --verbose --log --logFile="Cache/Intermediate/PackageLog.txt" "$@"

PackageEditor.sh

@@ -1,5 +1,5 @@
 #!/bin/sh
-# Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+# Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 set -e
 

PackagePlatforms.bat

@@ -1,6 +1,6 @@
 @echo off
 
-rem Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+rem Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 setlocal
 pushd

PackagePlatforms.command

@@ -0,0 +1,12 @@
+#!/bin/sh
+# Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
+
+set -e
+
+echo Building and packaging platforms data...
+
+# Change the path to the script root
+cd "`dirname "$0"`"
+
+# Run Flax.Build (also pass the arguments)
+bash ./Development/Scripts/Mac/CallBuildTool.sh --deploy --deployPlatforms --verbose --log --logFile="Cache/Intermediate/PackageLog.txt" "$@"

PackagePlatforms.sh

@@ -1,5 +1,5 @@
 #!/bin/sh
-# Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+# Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 set -e
 

README.md

@@ -6,7 +6,7 @@
 Flax Engine is a high quality modern 3D game engine written in C++ and C#.
 From stunning graphics to powerful scripts - Flax can give everything for your games. Designed for fast workflow with many ready to use features waiting for you right now. To learn more see the website ([www.flaxengine.com](https://flaxengine.com)).
 
-This repository contains full source code of the Flax (excluding NDA-protected platforms support). Anyone is welcome to contribute or use the modified source in Flax-based games.
+This repository contains full source code of the Flax Engine (excluding NDA-protected platforms support). Anyone is welcome to contribute or use the modified source in Flax-based games.
 
 # Development
 
@@ -42,20 +42,13 @@ Flax Visual Studio extension provides better programming workflow, C# scripts de
 * Compile Flax project (hit F7 or CTRL+Shift+B)
 * Run Flax (hit F5 key)
 
----
+> When building on Windows to support Vulkan rendering, first install the Vulkan SDK then set an environment variable to provide the path to the SDK prior to running GenerateProjectFiles.bat: `set VULKAN_SDK=%sdk_path%`
-
-**Note**
-
-If building on Windows to support Vulkan rendering, first install the Vulkan SDK then  set an environment variable to provide the path to the SDK prior to running GenerateProjectFiles.bat:
-
-    set VULKAN_SDK=C:\VulkanSDK\version\
-
----
 
 ## Linux
 
 * Install Visual Studio Code
 * Install Mono ([https://www.mono-project.com/download/stable](https://www.mono-project.com/download/stable))
+* Install Vulkan SDK ([https://vulkan.lunarg.com/](https://vulkan.lunarg.com/))
 * Install Git with LFS
 * Install requried packages: `sudo apt-get install libx11-dev libxcursor-dev libxinerama-dev nuget autoconf libogg-dev automake build-essential gettext cmake python libtool libtool-bin libpulse-dev libasound2-dev libjack-dev portaudio19-dev`
 * Install compiler `sudo apt-get install clang lldb lld` (Clang 6 or newer)
@@ -64,21 +57,31 @@ If building on Windows to support Vulkan rendering, first install the Vulkan SDK
 * Open workspace with Visual Code
 * Build and run (configuration and task named `Flax|Editor.Linux.Development|x64`)
 
+## Mac
+
+* Install XCode
+* Install Mono ([https://www.mono-project.com/download/stable](https://www.mono-project.com/download/stable))
+* Install Vulkan SDK ([https://vulkan.lunarg.com/](https://vulkan.lunarg.com/))
+* Clone repo (with LFS)
+* Run `GenerateProjectFiles.command`
+* Open workspace with XCode or Visual Studio Code
+* Build and run (configuration  `Editor.Mac.Development`)
+
 ## Workspace directory
 
 - **Binaries/** - executable files
   - **Editor/** - Flax Editor binaries
   - **Tools/** - tools binaries
-- **Cache/** - local data cache folder used by engine and tools
+- **Cache/** - local data cache folder used by the engine and tools
   - **Intermediate/** - intermediate files and cache for engine build
     - ***ProjectName*/** - per-project build cache data
     - **Deps/** - Flax.Build dependencies building cache
   - **Projects/** - project files location
-- **Content/** - assets and binary files used by engine and editor
+- **Content/** - assets and binary files used by the engine and editor
 - **Development/** - engine development files
   - **Scripts/** - utility scripts
-- **packages/** - Nuget packages cache location
+- **packages/** - NuGet packages cache location
-- **Source/** - source code lcoation
+- **Source/** - source code location
   - **Editor/** - Flax Editor source code
   - **Engine/** - Flax Engine source code
   - **Platforms/** - per-platform sources and dependency files
@@ -88,7 +91,7 @@ If building on Windows to support Vulkan rendering, first install the Vulkan SDK
       - **Binaries/** - per-platform binaries
         - **Game/** - Flax Game binaries
         - **Mono/** - Mono runtime files and data
-        - **ThirdParty/** - prebuild 3rd Party binaries
+        - **ThirdParty/** - prebuilt 3rd Party binaries
   - **Shaders/** - shaders source code
   - **ThirdParty/** - 3rd Party source code
   - **Tools/** - development tools source code
@@ -97,4 +100,4 @@ If building on Windows to support Vulkan rendering, first install the Vulkan SDK
 
 Using Flax source code is strictly governed by the Flax Engine End User License Agreement. If you don't agree to those terms, as amended from time to time, you are not permitted to access or use Flax Engine.
 
-We welcome any contributions to Flax Engine development through pull requests on GitHub. Most of our active development is in the master branch, so we prefer to take pull requests there (particularly for new features). We try to make sure that all new code adheres to the Flax coding standards. All contributions are governed by the terms of the EULA.
+We welcome any contributions to Flax Engine development through pull requests on GitHub. Most of our active development is in the master branch, so we prefer to take pull requests there (particularly for new features). We try to make sure that all new code adheres to the Flax coding standards. All contributions are governed by the terms of the [EULA](https://flaxengine.com/licensing/).

RegisterEngineLocation.bat

@@ -1,6 +1,6 @@
 @echo off
 
-rem Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
+rem Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 setlocal
 pushd %~dp0

SECURITY.md

@@ -0,0 +1,8 @@
+# Security
+
+## Reporting security vulnerabilities
+
+If you've found a security vulnerability in Flax, please do not create an issue on
+the GitHub issue tracker as it will be visible publicly.
+
+Instead, send an email to <contact@flaxengine.com>.

Source/Editor/Analytics/EditorAnalytics.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
+// Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 #include "EditorAnalytics.h"
 #include "EditorAnalyticsController.h"
@@ -107,6 +107,8 @@ void EditorAnalytics::StartSession()
             { UA_USER_AGENT, 0, "Windows " FLAXENGINE_VERSION_TEXT },
 #elif PLATFORM_LINUX
             { UA_USER_AGENT, 0, "Linux " FLAXENGINE_VERSION_TEXT },
+#elif PLATFORM_MAC
+            { UA_USER_AGENT, 0, "Mac " FLAXENGINE_VERSION_TEXT },
 #else
 #error "Unknown platform"
 #endif

Source/Editor/Analytics/EditorAnalytics.h

@@ -1,4 +1,4 @@
-// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
+// Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 #pragma once
 

Source/Editor/Analytics/EditorAnalyticsController.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
+// Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 #include "EditorAnalyticsController.h"
 #include "Editor/Cooker/GameCooker.h"

Source/Editor/Analytics/EditorAnalyticsController.h

@@ -1,4 +1,4 @@
-// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
+// Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 #pragma once
 

Source/Editor/Content/AssetItemConverter.cs

@@ -1,4 +1,4 @@
-// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
+// Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 using System;
 using Newtonsoft.Json;

Source/Editor/Content/Create/CreateFileEntry.cs

@@ -1,4 +1,4 @@
-// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
+// Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
 
 namespace FlaxEditor.Content.Create
 {