summaryrefslogtreecommitdiff
path: root/FETCH_DEPS.md
blob: 3d5cc0eaab68aa0639dca7d8af9006846268a66c (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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# Fetching Third-Party Dependencies

This project intentionally does NOT vendor large third-party libraries.

Currently required:

## miniaudio

Single-header audio library.

Source:
https://github.com/mackron/miniaudio

Required file:
- miniaudio.h

Expected location:
third_party/miniaudio.h

### Automatic fetch

Use one of the provided scripts:
- scripts/project_init.sh
- scripts/project_init.bat

### Manual fetch

Download miniaudio.h from:
https://raw.githubusercontent.com/mackron/miniaudio/master/miniaudio.h

and place it into:
third_party/miniaudio.h

## wgpu-native

WebGPU implementation via wgpu-native.

Source:
https://github.com/gfx-rs/wgpu-native

### Automatic fetch

Use one of the provided scripts:
- scripts/project_init.sh
- scripts/project_init.bat

These scripts will run `git submodule update --init --recursive` to fetch `wgpu-native` and then build its static library.

### Manual fetch

Run the following commands in the project root directory:
```bash
git submodule add https://github.com/gfx-rs/wgpu-native third_party/wgpu-native
git submodule update --init --recursive
cd third_party/wgpu-native
make lib-native # Requires Rust toolchain and LLVM/Clang to be installed.
cd ../..
```

Expected static library location (for linking):
- `third_party/wgpu-native/target/release/libwgpu_native.a` (or platform equivalent like `.lib` or `.dylib`)