aboutsummaryrefslogtreecommitdiff
path: root/docs/contribution/system-requirements.md
blob: 9fd7719cdb973fa1868d4c467ac7689c112c8d95 (plain) (blame)
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# System Requirements

## Build Requirements
* [Python 3.6+](https://www.python.org/downloads/)
* [Scons 3.0+](https://scons.org/)
* [Godot 4](https://github.com/godotengine/godot)

### Windows Requirements
* [Visual Studio Community](https://www.visualstudio.com/vs/community/)
* [Python 3.6+](https://www.python.org/downloads/windows/) - Ensure the installer adds Python to your PATH (you can rerun the installer to do so)

#### Installing Scons
With Python 3.6+ installed, you can install Scons through pip:
```sh
python -m pip install scons
```
If you get `Defaulting to user installation because normal site-packages is not writeable` then open a command prompt as Administrator and run the command again. When finished call:
```
scons --version
```
to ensure that you are using a correct version of Scons.

#### Installing Visual Studio
Ensure that if you install from Visual Studio 2017, 2019 or 2022, ensure you're installing the C++ tools.

If you're installing Visual Studio 2015, ensure you choose custom and pick C++ as the language.

### Linux Requirements
* GCC 12.3+

#### Debian/Ubuntu Linux Install
```sh
apt-get install \
  build-essential \
  scons \
  pkg-config \
  libx11-dev \
  libxcursor-dev \
  libxinerama-dev \
  libgl1-mesa-dev \
  libglu-dev \
  libasound2-dev \
  libpulse-dev \
  libudev-dev \
  libxi-dev \
  libxrandr-dev
```

#### Arch Linux Requirements
```sh
pacman -S --needed \
  scons \
  pkgconf \
  gcc \
  libxcursor \
  libxinerama \
  libxi \
  libxrandr \
  mesa \
  glu \
  libglvnd \
  alsa-lib \
  pulseaudio
```

### macOs Requirements
* [Xcode](https://apps.apple.com/us/app/xcode/id497799835)
    * Clang 14+
* [MoltenVK Vulkan SDK](https://sdk.lunarg.com/sdk/download/latest/mac/vulkan-sdk.dmg) 

#### Homebrew
```sh
brew install scons
```

#### MacPorts
```sh
sudo port install scons
```

Credit: [Godot Docs](https://docs.godotengine.org/en/stable/contributing/development/compiling/index.html)