From da3a54d184c60da9ad862c12f310352f89ffdf02 Mon Sep 17 00:00:00 2001 From: stefnotch Date: Wed, 27 Jan 2021 14:06:36 +0100 Subject: [PATCH 1/5] Pause on error On Windows, because people using Windows will double click on the file --- GenerateProjectFiles.bat | 1 + 1 file changed, 1 insertion(+) diff --git a/GenerateProjectFiles.bat b/GenerateProjectFiles.bat index 5db8aaf55..aeeac1c67 100644 --- a/GenerateProjectFiles.bat +++ b/GenerateProjectFiles.bat @@ -16,6 +16,7 @@ exit /B 0 :BuildToolFailed echo Flax.Build tool failed. +pause goto Exit :Exit From 80e0b0b0e5829c832bc51ab93dc85766d716b622 Mon Sep 17 00:00:00 2001 From: stefnotch Date: Wed, 27 Jan 2021 14:32:10 +0100 Subject: [PATCH 2/5] Document the "set as startup project" --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ad9f7ce4..a91acb56e 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,8 @@ Follow the instructions below to compile and run the engine from source. * Clone repo (with LFS) * Run **GenerateProjectFiles.bat** * Open `Flax.sln` and set solution configuration to **Editor.Development** and solution platform to **Win64** -* Compile Flax project (hit F7 key) +* Set Flax or FlaxEngine as startup project +* Compile Flax project (hit F7 or CTRL+Shift+B) * Run Flax (hit F5 key) ## Linux From 81865bd97e2946e6f863110e92e862958cacbccf Mon Sep 17 00:00:00 2001 From: stefnotch Date: Wed, 27 Jan 2021 14:32:25 +0100 Subject: [PATCH 3/5] Move Flax plugin up, since it's currently required --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a91acb56e..9c5b83aae 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,10 @@ This repository contains full source code of the Flax (excluding NDA-protected p Follow the instructions below to compile and run the engine from source. +## Flax plugin for Visual Studio + +Flax Visual Studio extension provides better programming workflow, C# scripts debugging functionality and allows to attach to running engine instance to debug C# source. This extension is available to download [here](https://marketplace.visualstudio.com/items?itemName=Flax.FlaxVS). + ## Windows * Install Visual Studio 2015 or newer @@ -50,10 +54,6 @@ Follow the instructions below to compile and run the engine from source. * Open workspace with Visual Code * Build and run -# Flax plugin for Visual Studio - -Flax Visual Studio extension provides better programming workflow, C# scripts debugging functionality and allows to attach to running engine instance to debug C# source. This extension is available to download [here](https://marketplace.visualstudio.com/items?itemName=Flax.FlaxVS). - ## Workspace directory - **Binaries/** - executable files From 691d9d9b882ae95548d7ae22c9cb2fe1a6cd2217 Mon Sep 17 00:00:00 2001 From: stefnotch Date: Wed, 27 Jan 2021 14:34:38 +0100 Subject: [PATCH 4/5] Document the GitHub basics --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e8eb1eb47..236fa6d67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,8 @@ Go check out our [Trello](https://trello.com/b/NQjLXRCP/flax-roadmap). ## **Want to contribute?** +* Fork the FlaxEngine, create a new branch and push your changes there. Then, create a pull request. + * When creating a PR for fixing an issue/bug make sure to describe as to what led to the fix for better understanding, for small and obvious fixes this is not really needed. However make sure to mention the relevant issue where it was first reported if possible. From 18e3d5191464325466d5f5cb6df7af466494cd7d Mon Sep 17 00:00:00 2001 From: stefnotch Date: Wed, 27 Jan 2021 18:08:38 +0100 Subject: [PATCH 5/5] Check LFS using file size --- Development/Scripts/Linux/CallBuildTool.sh | 6 ++++++ Development/Scripts/Windows/CallBuildTool.bat | 7 +++++++ 2 files changed, 13 insertions(+) diff --git a/Development/Scripts/Linux/CallBuildTool.sh b/Development/Scripts/Linux/CallBuildTool.sh index 3b4568918..1a8affe20 100755 --- a/Development/Scripts/Linux/CallBuildTool.sh +++ b/Development/Scripts/Linux/CallBuildTool.sh @@ -3,6 +3,12 @@ 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 diff --git a/Development/Scripts/Windows/CallBuildTool.bat b/Development/Scripts/Windows/CallBuildTool.bat index 4d9124776..c9729cf55 100644 --- a/Development/Scripts/Windows/CallBuildTool.bat +++ b/Development/Scripts/Windows/CallBuildTool.bat @@ -4,6 +4,10 @@ rem Copyright (c) 2012-2020 Wojciech Figat. All rights reserved. if not exist "Development\Scripts\Windows\GetMSBuildPath.bat" goto Error_InvalidLocation +for %%I in (Source\Logo.png) do if %%~zI LSS 2000 ( + goto Error_MissingLFS +) + call "Development\Scripts\Windows\GetMSBuildPath.bat" if errorlevel 1 goto Error_NoVisualStudioEnvironment @@ -33,6 +37,9 @@ Binaries\Tools\Flax.Build.exe %* if errorlevel 1 goto Error_FlaxBuildFailed exit /B 0 +:Error_MissingLFS +echo CallBuildTool ERROR: Repository was not cloned using Git LFS +goto Exit :Error_InvalidLocation echo CallBuildTool ERROR: The script is in invalid directory. goto Exit