Skip to content

Commit 6f0d03b

Browse files
committed
Add build tool guide
1 parent c282bcf commit 6f0d03b

File tree

4 files changed

+26
-0
lines changed

4 files changed

+26
-0
lines changed

manual/editor/flax-build/guide.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Build Tool Guide
2+
3+
## Deps
4+
5+
![Deps](media/deps.png)
6+
7+
`Flax.Build` handles 3rd Party dependencies downloading, updating and building for all supported platforms. Each package defines the custom logic to download itself (eg. via `git clone` or `zip` decompress). Then code is compiled for selected set of platforms (eg. via `msbuild` or `cmake`). Finally, output binaries are copied into `Source/Platforms/<platform>/Binaries/ThirdParty/<arch>` folder to be used when compiling the engine.
8+
9+
Example command line to update all dependencies for a platform `Android`:
10+
11+
```
12+
Flax.Build -log -ReBuildDeps -verbose -platform=Android
13+
```
14+
15+
Example command line to update `NewtonsoftJson` dependency for all platforms:
16+
17+
```
18+
Flax.Build -log -ReBuildDeps -verbose -depsToBuild=NewtonsoftJson
19+
```

manual/editor/flax-build/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ Major features:
2020

2121
This documentation section covers most of the topics related to Flax.Build tool. To learn more please refer to Flax.Build sources located under `Source\Tools\Flax.Build` and/or use `Binaries\Tools\Flax.Build.exe -help` to learn more about usage. The engine repository contains useful scripts that are wrappers against the build tool and automatically compile its sources.
2222

23+
## In this section
24+
25+
* [API tags](api-tags.md)
26+
* [Build Blugins](plugins.md)
27+
* [Build Tool Guide](guide.md)
28+
2329
## Build Scripts
2430

2531
The main source of build configuration are **.Build.cs** files located in the project `Source` directory. Written in **C#**, scripts can contain targets, modules, SDKs, or other utilities used for building. When generating project scripts files, all build scripts are included in **Rules** project which defines the build rules and can be explored with code IDE.
18.1 KB
Loading

manual/toc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@
5959
## [Flax.Build](editor/flax-build/index.md)
6060
### [API Tags](editor/flax-build/api-tags.md)
6161
### [Plugins](editor/flax-build/plugins.md)
62+
### [Guide](editor/flax-build/guide.md)
6263
## [Editor Options](editor/options/index.md)
6364
## [Profiling](editor/profiling/index.md)
6465
### [Profiler](editor/profiling/profiler.md)

0 commit comments

Comments
 (0)