Skip to content

Commit

Permalink
updated readme. added Build section
Browse files Browse the repository at this point in the history
  • Loading branch information
DmitriySalnikov committed Sep 14, 2023
1 parent 1693f7d commit 5254896
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
30 changes: 30 additions & 0 deletions addons/debug_draw_3d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ Most likely, when exporting a release version of a game, you don't want to expor

![export_features](/images/export_features.png)

In C#, these tags are not taken into account at the moment. So you will have to manually specify `FORCED_DD3D`.

![csharp_compilation_symbols](/images/csharp_compilation_symbols.png)

## Known issues and limitations

Enabling occlusion culing can lower fps instead of increasing it. At the moment I do not know how to speed up the calculation of the visibility of objects.
Expand All @@ -151,3 +155,29 @@ The entire text overlay can only be placed in one corner, unlike `DataGraphs`.

`DebugDrawDemoScene.tscn` in play mode
![screenshot_3](/images/screenshot_3.png)

## Build

As well as for the engine itself, you will need to configure the [environment](https://docs.godotengine.org/en/4.1/contributing/development/compiling/index.html).
And also you need to apply several patches:

```bash
cd godot-cpp
git apply --ignore-space-change --ignore-whitespace ../patches/always_build_fix.patch
git apply --ignore-space-change --ignore-whitespace ../patches/1165.patch
# Optional
## Build only the necessary classes
git apply --ignore-space-change --ignore-whitespace ../patches/godot_cpp_exclude_unused_classes.patch
## Faster build
git apply --ignore-space-change --ignore-whitespace ../patches/unity_build.patch
```

Then you can just run scons as usual:

```bash
# build for the current system.
# target=editor is used for both the editor and the debug template.
scons target=editor dev_build=yes debug_symbols=yes
# build for the android. ANDROID_NDK_ROOT is required in your environment variables.
scons platform=android target=template_release arch=arm64v8
```
Binary file added images/csharp_compilation_symbols.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion src/editor/generate_csharp_bindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,6 @@ void GenerateCSharpBindingsPlugin::generate_enum(const StringName &cls, const St
log(enm, 3);

int added_items = 0;
// TODO flags?
line(FMT_STR("public enum {0} : long", enm));
{
TAB();
Expand Down Expand Up @@ -859,4 +858,7 @@ GenerateCSharpBindingsPlugin::IfDefGuard GenerateCSharpBindingsPlugin::ifdef(con

#undef TAB
#undef IFDEF
#undef DD3D_ENABLED_STR
#undef IFDEF_DD3D_ENABLED
#undef IFELSE
#endif

0 comments on commit 5254896

Please sign in to comment.