Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/defold/doc
Browse files Browse the repository at this point in the history
  • Loading branch information
britzl committed Sep 24, 2024
2 parents dacb182 + 9d68591 commit e12eaad
Show file tree
Hide file tree
Showing 12 changed files with 404 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/en/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -817,6 +817,10 @@
"path": "/manuals/editor-scripts",
"name": "Editor scripts"
},
{
"path": "/manuals/editor-scripts-ui",
"name": "Editor scripts: UI"
},
{
"path": "/manuals/debugging-game-logic/#running-the-debugger",
"name": "Debugger"
Expand Down
33 changes: 33 additions & 0 deletions docs/en/manuals/app-manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ brief: This manual describes how the app manifest can be used to exclude feature
# App manifest

The application manifest is used to exclude or control which features to include in the engine. Excluding unused features of the engine is a recommended best practice since it will decrease the final binary size of your game.
Also application manifest contains some options to control compiling code for HTML5 platform like minimum browser supported version/memory settings that's also can affect on result binary size.

![](images/app_manifest/create-app-manifest.png)

Expand Down Expand Up @@ -65,3 +66,35 @@ Select which graphics backend to use.
* OpenGL - Include only OpenGL.
* Vulkan - Include only Vulkan.
* OpenGL and Vulkan - Include both OpenGL and Vulkan. Vulkan will be the default and fall back to OpenGL if Vulkan is not available.


## Minimum Safari version (js-web and wasm-web only)
YAML field name: **minSafariVersion**
Default value: **90000**

Minimum supported version of Safari. Cannot be less than 90000. For more information look Emscripten compiler options [link](https://emscripten.org/docs/tools_reference/settings_reference.html?highlight=environment#min-safari-version).

## Minimum Firefox version (js-web and wasm-web only)
YAML field name: **minFirefoxVersion**
Default value: **34**

Minimum supported version of Firefox. Cannot be less than 34. For more information look Emscripten compiler options [link](https://emscripten.org/docs/tools_reference/settings_reference.html?highlight=environment#min-firefox-version).

## Minimum Chrome version (js-web and wasm-web only)
YAML field name: **minChromeVersion**
Default value: **32**

Minimum supported version of Chrome. Cannot be less than 32. For more information look Emscripten compiler options [link](https://emscripten.org/docs/tools_reference/settings_reference.html?highlight=environment#min-chrome-version).

## Initial memory (js-web and wasm-web only)
YAML field name: **initialMemory**
Default value: **33554432**

The size of memory that allocated for web application. In case if ALLOW_MEMORY_GROWTH=0 (js-web) - there is a total amount of memory that web application can use. for more information look [link](https://emscripten.org/docs/tools_reference/settings_reference.html?highlight=environment#initial-memory). Value in bytes. Note that value must be a multiple of WebAssembly page size (64KiB).
That options relates to `html5.heap_size` in game.project [link](https://defold.com/manuals/html5/#heap-size). Option that configured via application manifest is set during compilation and used as default value for INITIAL_MEMORY option. Value from game.project overrides value from application manifest and used in runtime.

## Stack size (js-web and wasm-web only)
YAML field name: **stackSize**
Default value: **5242880**

The stack size of application. For more information look [link](https://emscripten.org/docs/tools_reference/settings_reference.html?highlight=environment#stack-size). Value in bytes.
366 changes: 366 additions & 0 deletions docs/en/manuals/editor-scripts-ui.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/en/manuals/editor-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ You can interact with the editor using `editor` package that defines this API:
- `editor.execute(cmd, [...args], [options])` — run a shell command, optionally capturing its output.
- `editor.save()` — persist all unsaved changed to disk.
- `editor.transact(txs)` — modify the editor in-memory state using 1 or more transaction steps created with `editor.tx.*` functions.
- `editor.ui.*` — various UI-related functions, see [UI manual](/manuals/editor-scripts-ui).

## Commands

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e12eaad

Please sign in to comment.