Update README.md

This commit is contained in:
Reinier Vens 2021-05-11 09:45:38 +01:00
commit 885f60e3f1

View file

@ -102,9 +102,7 @@ By pushing to this repository or submitting a pull request, you are implicitly p
In order to checkout the project, you need a git client (Github's zip download will not work!). You also need to have installed [Git LFS (Large File Storage)](https://git-lfs.github.com/). This is necessary because assets in gamedev projects can get rather large, and Git is essentially a text versioning system that does not by itself support that use case well. After installing LFS you'll need a Git client. I recommend [Github Desktop](https://desktop.github.com/), which has a nice simplified workflow and integrates with the site. For more advanced users, there's nothing wrong with using the command line or a more comprehensive client like [GitKraken](https://www.gitkraken.com/), but beginners beware that it's easy to shoot yourself in the foot that way.
When you have synced with the repository, you can open the project using Unity. The project uses Unity 2020.2 at the moment, and while it may work with newer or older versions, that cannot be guaranteed. You can open the project by opening the root of this repository either directly with the Unity Editor, or using [Unity Hub](https://public-cdn.cloud.unity3d.com/hub/prod/UnityHubSetup.exe), which will also take care of downloading the correct version of the Editor.
**Important note:** One of our VFX features currently relies on a custom modification of the Depth of Field shader in Unity's postprocessing stack. When you open the project this mod will not be there so you may experience a blurred screen. You can fix this by replacing the file `Library\PackageCache\com.unity.postprocessing@2.3.0\PostProcessing\Shaders\Builtins\DepthOfField.hlsl` with the file of the same name placed in the repository root.
When you have synced with the repository, you can open the project using Unity. The project uses Unity 2020.3.2f1 at the moment, and while it may work with newer or older versions, that cannot be guaranteed. You can open the project by opening the root of this repository either directly with the Unity Editor, or using [Unity Hub](https://public-cdn.cloud.unity3d.com/hub/prod/UnityHubSetup.exe), which will also take care of downloading the correct version of the Editor.
### Choosing a Task