summaryrefslogtreecommitdiffstats
path: root/Troubleshooting.md
blob: dfa8a480aea7f0864ae1d693e3d2c7ef1d5b181d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
### Build fails
  
* Make sure your code is up-to-date. When updating existing repository, don't forget to update all submodules:

```
git pull
git submodule update --recursive
```

* Try to [get clean version](https://github.com/DiligentGraphics/DiligentEngine#cloning-the-repository)

* Make sure your build environment is up-to-date and properly configured:
  * When building with Visual Studio, make sure you use Windows SDK 10.0.17763.0 or later,
    have C++ build tools and Visual C++ ATL Support installed.
  * When building for UWP, make sure you have UWP build tools.
  * When building for Android, make sure all your tools are up to date, you have
    [NDK and CMake installed](https://developer.android.com/studio/projects/install-ndk).
    If you are not using CMake version bundled with Android Studio, make sure your build files are
    [properly configured](https://developer.android.com/studio/projects/add-native-code.html#use_a_custom_cmake_version).
  * When using gcc, make sure the compiler version is at least 7.4.
  * Make sure you build your project with c++11 features enabled.

* When including Diligent headers, make sure that exactly one of `PLATFORM_WIN32`,
  `PLATFORM_UNIVERSAL_WINDOWS`, `PLATFORM_ANDROID`, `PLATFORM_LINUX`, `PLATFORM_MACOS`, and
  `PLATFORM_IOS` macros is defined as `1`.

* When building on Windows, generating Visual Studio project files is the recommended way. **Do not**
  use Visual Studio's built-in CMake and *Open Folder* option. Other IDEs such as Visual Studio
  Code or CLion are not guaranteed to work.
 
* If on Windows you get long path error, try clonning the project to a folder with shorter name
  such as `c:/git/DiligentEngine`.

### Projects don't run

* When running from the command line, make sure that the project's `assets` folder is set as working directory
* Try using different backends: use `-mode d3d11` or `-mode gl` command line options