Updated the project settings manual to reflect ed 2.

Updated the editor overview for clarity.

docs/en/manuals/project-settings.md

@@ -7,391 +7,433 @@ brief: This manual describes how project specific settings work in Defold.
 
 The file *game.project* contains all project wide settings. It must stay in the root folder of the project and must be named *game.project*. The first thing the engine does when starting up and launching your game is look for this file.
 
-Every setting in the file belongs to a category. The format of the file is simple text and can be edited by any standard text editor. The format looks like this:
+Every setting in the file belongs to a category. When you open the file Defold presents all settings grouped by category.
 
-```ini
-[category1]
-setting1 = value
-setting2 = value
-[category2]
-...
-```
-
-A real example is:
-
-```ini
-[bootstrap]
-main_collection = /main/main.collectionc
-```
-
-which means that the setting *main_collection* belongs to the *bootstrap* category.
-Whenever a file reference is used, like the example above, the path needs to be appended with a 'c' character, which means you're referencing the compiled version of the file.
-Also note that the folder containing *game.project* will be the project root, which is why there is an initial '/' in the setting path.
+![Project settings](images/project-settings/settings.jpg)
 
 Below are all the available settings, arranged by section. Some settings are not yet exposed in the settings editor (these are marked "hidden setting" below), but can be set manually by right clicking "game.project" and selecting <kbd>Open With ▸ Text Editor</kbd>.
 
-## Setting config values on engine startup
-
-When the engine starts, it is possible to provide config values from the command line that override the *game.project* settings:
-
-```bash
-# Specify a bootstap collection
-$ dmengine --config=bootstrap.main_collection=/my.collectionc
-
-# Set the custom value "test.my_value"
-$ dmengine --config=test.my_value=4711
-```
-
-Custom values can---just like any other config value---be read with [`sys.get_config()`](/ref/sys/#sys.get_config).
-
 ## Project
 
-title
+Title
 : The title of the application.
 
-version
+Version
 : The version of the application.
 
-write_log
+Write Log
 : When checked, the engine will write a log file *log.txt* in the project root. When running on iOS, the log file can be accessed through iTunes and the *Apps* tab and the *File Sharing* section. On Android, the file is stored in the app's external storage. When running the *dmengine* development app, you can view the log with:
 
 ```bash
 $ adb shell cat /mnt/sdcard/Android/data/com.defold.dmengine/files/log.txt
 ```
 
-compress_archive
+Compress Archive
 : Enables compression of archives when bundling. Note that this currently applies to all platforms except Android where the apk already contains all data compressed.
 
-dependencies
-: A comma-separated list of URLs to the project *Library URL*s (can be found in the [Defold dashboard](//dashboard.defold.com)) that this project uses. Note that you need to be a member of the dependent projects.
+Dependencies
+: A list of URLs to the project *Library URL*s. For Defold hosted projects, the URL is found on the project page on the [Dashboard](//dashboard.defold.com)). Note that you need read access to the URL. For Defold hosted projects, that means you need to be a member of the dependent projects.
 
-custom_resources (hidden setting)
+Custom Resources
 : A comma separated list of resources that will be included in the project. If directories are specified, all files and directories in that directory are recursively included.
 
-bundle_resources (hidden setting)
+_bundle_resources_ (hidden setting)
 : A directory containing resource files and folders that should be copied as-is into the resulting package when bundling. The directory is specified with an absolute path from the project root, for example `/res`. The resource directory must contain subfolders named by `platform`, or `architecure-platform`.
-  
+
   :[platforms](../shared/platforms.md)
 
   A subfolder named `common` is also allowed, containing resource files common for all platforms.
 
-bundle_exclude_resources (hidden setting)
+_bundle_exclude_resources_ (hidden setting)
 : A comma separated list of resources that should not be included in the bundle.
 
 ## Bootstrap
 
-main_collection
-: File reference of the collection to use for starting the application, `/logic/main.collectionc` by default.
+Main Collection
+: File reference of the collection to use for starting the application, `/logic/main.collection` by default.
 
-render
-: Which render file to use, which defines the render pipeline, `/builtins/render/default.renderc` by default.
+Render
+: Which render setup file to use, which defines the render pipeline, `/builtins/render/default.render` by default.
 
 ## Library
 
-include_dirs
+Include Dirs
 : A space separated list of directories that should be shared from your project via library sharing.
 
 ## Script
 
-shared_state
-: Check to share a single Lua state between all script types, checked by default.
+Shared State
+: Check to share a single Lua state between all script types, unchecked by default.
 
 ## Tracking
 
-app_id
+App Id
 : A unique tracking ID for this project. The project tracking ID an be found on the project dashboard.
 
 ## Display
 
-width
+Width
 : The width in pixels of the application window, `960` by default.
 
-height
+Height
 : The height in pixels of the application window, `640` by default.
 
-high_dpi
-: Creates a high dpi back buffer on displays that support it. I.e. the game will render in higher resolution.
+High Dpi
+: Creates a high dpi back buffer on displays that support it. Typically the game will render in double the resolution than what is set in the *Width* and *Height* settings, which will still be the logical resolution used in scripts and properties.
 
-samples
+Samples
 : How many samples to use for super sampling anti-aliasing, `0` by default, which means it is turned off.
 
-fullscreen
+Fullscreen
 : Check if the application should start full screen. If unchecked, the application runs windowed.
 
-update_frequency
+Update Frequency
 : Frame update frequency, `60` by default. Valid values are `60`, `30`, `20`, `15`, `12`, `10`, `6`, `5`, `4`, `3`, `2` or `1`.
 
-variable_dt
-: Check if time step should be measured against actual time or be fixed (set to *update_frequency*).
+Variable Dt
+: Check if time step should be measured against actual time spent in the update loop, uncheck if you want fixed time step (as set in *update_frequency*).
 
-display_profiles
+Display Profiles
 : Specifies which display profiles file to use, `/builtins/render/default.display_profilesc` by default.
 
-dynamic_orientation
+Dynamic Orientation
 : Check if the app should dynamically switch between portrait and landscape on device rotation. Note that the development app does not currently respect this setting.
 
 ## Physics
 
-type
+Type
 : Which type of physics to use, `2D` (default) or `3D`.
 
-gravity_y
+Gravity Y
 : World gravity along y-axis, `-10` by default (natural gravity)
 
-debug
+Debug
 : Check if physics should be visualized for debugging.
 
-debug_alpha
+Debug Alpha
 : Alpha component value for visualized physics, `0`--`1`. The value is `0.9` by default.
 
-world_count
-: Max number of concurrent physics worlds, `4` by default (careful, they waste memory).
+World Count
+: Max number of concurrent physics worlds, `4` by default. If you load more than 4 worlds simultaneously through collection proxies you need to increase this value. Be aware that each physics world allocates a fair amount of memory.
 
-gravity_x
+Gravity X
 : World gravity along x-axis, `0` by default.
 
-gravity_z
+Gravity Z
 : World gravity along z-axis, `0` by default.
 
-scale
-: How to scale the physics worlds in relation to the game world for numerical precision, `0.01`--`1`. The value is `0.02` by default, meaning that the physics engine will see 160 units as 3.2 meters.
+Scale
+: Tells the physics engine how to scale the physics worlds in relation to the game world for numerical precision, `0.01`--`1.0`. If the value is set to `0.02`, it means that the physics engine will view 50 units as 1 meter ($1 / 0.02$). The default value is `1.0`.
 
-debug_scale
+Debug Scale
 : How big to draw unit objects in physics, like triads and normals, `30` by default.
 
-max_collisions
+Max Collisions
 : How many collisions that will be reported back to the scripts, `64` by default.
 
-max_contacts
+Max Contacts
 : How many contact points that will be reported back to the scripts, `128` by default.
 
-contact_impulse_limit
-: Ignore contact impulses with values less than this setting, `0` by default.
+Contact Impulse Limit
+: Ignore contact impulses with values less than this setting, `0.0` by default.
+
+Ray Cast Limit 2d
+: The max number of 2d ray cast requests per frame. `64` by default.
+
+Ray Cast Limit 3d
+: The max number of 3d ray cast requests per frame. `128` by default.
+
+Trigger Overlap Capacity
+: The maximum number of overlapping physics triggers. `16` by default.
 
 ## Graphics
 
-default_texture_min_filter
-: Specifies which filtering to use for min filtering, `linear` (default) or `nearest`.
+Default Texture Min Filter
+: Specifies which filtering to use for minification filtering, `linear` (default) or `nearest`.
 
-default_texture_mag_filter
-: Specifies which filtering to use for mag filtering, `linear` (default) or `nearest`.
+Default Texture Mag Filter
+: Specifies which filtering to use for magnification filtering, `linear` (default) or `nearest`.
 
-max_draw_calls
+Max Draw Calls
 : The max number of render calls, `1024` by default.
 
-max_characters:
-: The max number of text character to pre-allocate, `8192` by default.
+Max Characters:
+: The number of characters pre-allocated in the text rendering buffer, i.e. the number of characters that can be displayed each frame, `8192` by default.
 
-max_debug_vertices
+Max Debug Vertices
 : The maximum number of debug vertices. Used for physics shape rendering among other things, `10000` by default.
 
-texture_profiles
+Texture Profiles
 : The texture profiles file to use for this project, `/builtins/graphics/default.texture_profiles` by default.
 
 ## Input
 
-repeat_delay
+Repeat Delay
 : Seconds to wait before a held down input should start repeating itself, `0.5` by default.
 
-repeat_interval
+Repeat Interval
 : Seconds to wait between each repetition of a held down input, `0.2` by default.
 
-gamepads
-: File reference of the gamepads config file, which maps gamepad signals to OS, `/builtins/input/default.gamepadsc` by default.
+Gamepads
+: File reference of the gamepads config file, which maps gamepad signals to OS, `/builtins/input/default.gamepads` by default.
 
-game_binding
-: File reference of the input config file, which maps hardware inputs to actions, `/input/game.input_bindingc` by default.
+Game Binding
+: File reference of the input config file, which maps hardware inputs to actions, `/input/game.input_binding` by default.
+
+Use Accelerometer
+: Check to make the engine receive accelerator input events each frame. Disabling accelerometer input may give some performance benefit, checked by default.
 
 ## Resource
 
-http_cache
+Http Cache
 : Check if the HTTP cache should be enabled for faster loads over network.
 
-uri
+Uri
 : Where to find the project build data, in URI format.
 
-max_resources
+Max Resources
 : The max number of resources that can be loaded at the same time, `1024` by default.
 
 ## Network
 
-http_timeout
+Http Timeout
 : The HTTP timeout in seconds. Set to `0` to disable timeout, which is the default.
 
 ## Collection
 
-max_instances
+Max Instances
 : Max number of game object instances in a collection, `1024` by default.
 
 ## Sound
 
-gain
+Gain
 : Global gain (volume), `0`--`1`, The value is `1` by default.
 
-max_sound_data
+Max Sound Data
 : Max number of sound resources, i.e the number of unique sound files at runtime, `128` by default.
 
-max_sound_buffers
+Max Sound Buffers
 : (Currently not used) Max number of concurrent sound buffers, `32` by default.
 
-max_sound_sources
+Max Sound Sources
 : (Currently not used) Max number of concurrently playing sounds, `16` by default.
 
-max_sound_instances
+Max Sound Instances
 : Max number of concurrent sound instances, i.e. actual sounds played at the same time. `256` by default.
 
 ## Sprite
 
-max_count
+Max Count
 : Max number of sprites, `128` by default.
 
-subpixels
+Subpixels
 : Check to allow sprites to appear unaligned with respect to pixels, checked by default.
 
 ## Spine
 
-max_count
+Max Count
 : Max number of spine models, `128` by default.
 
 ## GUI
 
-max_count
+Max Count
 : Max number of GUI components, `64` by default.
 
+Max Particlefx Count
+: The max number of concurrent emitters, `64` by default.
+
+Max Particle Count
+: The max number of concurrent particles, `1024` by default.
+
 ## Label
 
-max_count
+Max Count
 : Max number of labels, `64` by default.
 
-sub_pixels
+Subpixels
 : Check to allow lables to appear unaligned with respect to pixels, checked by default.
 
 ## Particle FX
 
-max_emitter_count
+Max Count
 : The max number of concurrent emitters, `64` by default.
 
-max_particle_count
+Max Particle Count
 : The max number of concurrent particles, `1024` by default.
 
 ## Collection proxy
 
-max_count
+Max Count
 : Max number of collection proxies, `8` by default.
 
 ## Collection factory
 
-max_count
+Max Count
 : Max number of collection factories, `128` by default.
 
 ## Factory
 
-max_count
+Max Count
 : Max number of game object factories, `128` by default.
 
 ## iOS
 
-app_icon_WxH
+App Icon 57x57--180x180
 : Image file to use as application icon at given width and height dimensions `W` &times; `H`.
 
-launch_image_WxH
-: Image file to use as application launch image for resolution width and height dimensions `W` &times; `H`. Note that iOS selects the display resolution based on the launch image.
+Launch Image 320x480--2436x1125
+: Image file to use as application launch image for resolution width and height dimensions `W` &times; `H`. iOS selects the display resolution based on the launch image.
 
-pre_rendered_icons
+Pre Rendered Icons
 : (iOS 6 and earlier) Check if your icons are pre-rendered. If this is unchecked the icons will get a glossy highlight added automatically.
 
-bundle_identifier
+Bundle Identifier
 : The bundle identifier lets iOS recognize any updates to your app. Your bundle ID must be registered with Apple and be unique to your app. You cannot use the same identifier for both iOS and OS X apps.
 
-infoplist
+Info.plist
 : If specified, use this info.plist file when bundling your app.
 
 ## Android
 
-app_icon_WxH
+App Icon 36x36--192x192
 : Image file to use as application icon at given width and height dimensions `W` &times; `H`.
 
-version_code
-: An integer value indicating the version of the app. Increase the value for each subsequent update.
-
-push_icon_SIZE
+Push Icon Small--LargeXxxhdpi
 : Image files to be used as custom push notification icon on Android. The icons will automatically be used for both local or remote push notifications. If not set the application icon will be used by default.
 
-push_field_title
+Push Field Title
 : Specifies which payload JSON field should be used as notification title. Leaving this setting empty makes the pushes default to the application name as title.
 
-push_field_text
+Push Field Text
 : Specifies which payload JSON field should be used as notification text. If left empty, the text in the field `alert` is used, just as on iOS.
 
-package
+Version Code
+: An integer value indicating the version of the app. Increase the value for each subsequent update.
+
+Package
 : Package identifier.
 
-gcm_sender_id
+Gcm Sender Id
 : Google Cloud Messaging Sender Id. Set this to the string assigned by Google to enable push notifications.
 
-manifest
+Manifest
 : If set, use the specified Android manifest XML file when bundling.
 
-iap_provider
+Iap Provider
 : Specifies which store to use. Valid options are `Amazon` and `GooglePlay`, `GooglePlay` by default.
 
-input_method
+Input Method
 : Specifies which method to use to get keyboard input on Android devices. Valid options are `KeyEvent` (old method) and `HiddenInputField` (new). `KeyEvent` by default.
 
-immersive_mode
+Immersive Mode
 : If set, hides the navigation and status bars and lets your app capture all touch events on the screen.
 
-## OS X
+## MacOS / OS X
 
-app_icon
-: Image file to use as application icon on OS X.
+App Icon
+: Image file to use as application icon on MacOS.
 
-infoplist
+Info.plist
 : If set, use the specified info.plist file when bundling.
 
-bundle_identifier
+Bundle Identifier
 : The bundle identifier lets OS X recognize updates to your app. Your bundle ID must be registered with Apple and be unique to your app. You cannot use the same identifier for both iOS and OS X apps.
 
 ## Windows
 
-app_icon
+App Icon
 : Image file to use as application icon on Windows.
 
+Iap Provider
+: Specifies which store to use. Valid options are `None` and `Gameroom`, `None` by default.
+
 ## HTML5
 
-set_custom_heap_size
+Set Custom Heap Size
 : If set, Emscripten allocates *custom_heap_size* number of bytes for the application heap.
 
-custom_heap_size
+Custom Heap Size
 : Sets the custom heap size for Emscripten to use if *set_custom_heap_size* is set. If not set, 256MB is allocated for the application heap.
 
-include_dev_tool
+Include Dev Tool
 : Includes a visual dev-tool in the application that allows tracking of memory usage.
 
-htmlfile
+.html Shell
 : If set, use the specified template HTML file when bundling.
 
-cssfile
+Custom .css
 : If set, use the specified CSS file when bundling.
 
-splash_image
+Splash Image
 : If set, use the specified splash image on startup when bundling.
 
-archive_location_prefix
+Archive Location Prefix
 : When bundling for HTML5 game data is split up into one or more archive data files. When the engine starts the game, these archive files are read into memory. Use this setting to specify the location of the data, `archive` by default.
 
-archive_location_suffix
+Archive Location Suffix
 : Suffix to be appended to the archive files. Useful to, for instance, force non-cached content from a CDN (`?version2` for example).
 
 ## Facebook
 
-appid (hidden setting)
+Appid
 : The application id as issued by Facebook.
 
 ## IAP
 
-auto_finish_transactions
+Auto Finish Transactions
 : Check to automatically finish IAP transactions. If unchecked, you need to explicitly call `iap.finish()` after a successful transaction, checked by default.
 
+## Live update
+
+Private Key
+: If set, use the specified private key file when bundling live update content. If no key file is set, a key is generated.
+
+Public Key
+: If set, use the specified public key file when bundling live update content. If no key file is set, a key is generated.
+
+## Native extension
+
+_App Manifest (alpha state)_
+: If set, use the app manifest to customize the engine build. This allows you to remove unneeded parts from the engine making it possible to decrease the final binary size. Note that this feature is in alpha state. Please visit [the forum](https://forum.defold.com/t/native-extensions/4946/142) for information on how to proceed.
+
+## Profiler
+
+Track Cpu
+: If checked, enable CPU profiling in release versions of the builds. Normally, you can only access profiling information in debug builds.
+
+## File format
+
+The format of the settings file is simple text and can be edited by any standard text editor. The format looks like this:
+
+```ini
+[category1]
+setting1 = value
+setting2 = value
+[category2]
+...
+```
+
+A real example is:
+
+```ini
+[bootstrap]
+main_collection = /main/main.collectionc
+```
 
+which means that the setting *main_collection* belongs to the *bootstrap* category.
+Whenever a file reference is used, like the example above, the path needs to be appended with a 'c' character, which means you're referencing the compiled version of the file.
+Also note that the folder containing *game.project* will be the project root, which is why there is an initial '/' in the setting path.
 
+## Setting config values on engine startup
+
+When the engine starts, it is possible to provide config values from the command line that override the *game.project* settings:
+
+```bash
+# Specify a bootstap collection
+$ dmengine --config=bootstrap.main_collection=/my.collectionc
+
+# Set the custom value "test.my_value"
+$ dmengine --config=test.my_value=4711
+```
+
+Custom values can---just like any other config value---be read with [`sys.get_config()`](/ref/sys/#sys.get_config).

docs/en/shared/editor-views.md

@@ -20,7 +20,7 @@ The *Editor* view
 : The center view shows the currently open file in an editor for that file type. In all visual editors you can navigate the camera:
 
    - Pan: <kbd>Alt + left mouse button</kbd>.
-   - Pan (editor 1): <kbd>Alt + Middle button</kbd> (three button mouse) or <kbd>Option + Ctrl + Mouse button</kbd> (one button mouse)
+   - Pan (editor 1): <kbd>Alt + Middle button</kbd> (three button mouse) or <kbd>Ctrl + ⌘ + Mouse button</kbd> (one button mouse, Mac) or <kbd>Ctrl + Alt + Mouse button</kbd> (one button mouse, Windows/Linux). You can change the mouse type in the application preferences, under *Defold / Scene Editor* and *Mouse Type*.
    - Zoom: <kbd>Alt + Right button</kbd> (three button mouse) or <kbd>Ctrl + Mouse button</kbd> (one button). If your mouse has a scroll wheel, it can be used to zoom.
    - Rotate in 3D (editor 2): <kbd>Ctrl + left mouse button</kbd>.
 

publish.sh

@@ -5,7 +5,7 @@ GSUTIL="lib/google-cloud-sdk/bin/gsutil"
 
 if [ "$(uname)" == "Darwin" ]; then
     GCSDK="https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-148.0.1-darwin-x86_64.tar.gz"
-fi        
+fi
 
 if [ ! -f $GSUTIL ]; then
     echo "Installing Google Cloud SDK..."