Honza/Dokumentace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix documentation inconsistencies and bump document versions

Browse Source
This commit is contained in:
Jan Doubravský
2026-08-18 12:22:57 +02:00
parent 5c0f2f758f
commit b337da11a6
17 changed files with 170 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Godot/DESIGN_DOCUMENT_GODOT.md
+4 -4
View File
@@ -1,6 +1,6 @@
# Godot Development Guidelines
**Document Version:** v1
**Document Version:** v2
> **Note on Versioning:**
> - This document version is independent — reused across Godot projects
@@ -90,7 +90,7 @@ Use a dedicated `Log` autoload that wraps `print`/`push_warning`/`push_error` wi
The file sink retains **max 10 log files**. Each run creates a new file via the timestamp in the filename.
The `DEBUG` sink is only active when `Constants.DEBUG` is `true` (controlled by an `ENV_DEBUG` value read at startup, e.g. from a `user://settings.cfg` or an export feature tag).
The `DEBUG` sink is only active when `Constants.DEFAULT_DEBUG` is `true` (controlled by an `ENV_DEBUG` value read at startup, e.g. from a `user://settings.cfg` or an export feature tag).
Additional sinks (e.g. an in-game debug overlay / console panel) may be added per project.
@@ -112,7 +112,7 @@ Additional sinks (e.g. an in-game debug overlay / console panel) may be added pe
## 7. Settings and Secrets
- Store user/runtime config in `user://settings.cfg` via `ConfigFile`
- Toggle debug behaviour with an `ENV_DEBUG`-style flag read at startup into `Constants.DEBUG`
- Toggle debug behaviour with an `ENV_DEBUG`-style flag read at startup into `Constants.DEFAULT_DEBUG`
- Never commit any secrets; keep them out of `project.godot` and committed `.tres`/`.cfg` files
---
@@ -191,7 +191,7 @@ When the game is distributed as a standalone build:
godot --headless --export-release "Windows Desktop" build/Game.exe
```
- Compiled builds are stored in `build/` (or `dist/`). Decide per project whether builds are committed — for small internal distribution the repository may serve as the channel; otherwise keep `build/` in `.gitignore`
- Strip debug-only nodes and disable `Constants.DEBUG` in release presets
- Strip debug-only nodes and disable `Constants.DEFAULT_DEBUG` in release presets
> This section applies only to projects that produce shippable builds.