Skip to content

Keymap #539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/en/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -1007,10 +1007,6 @@
"path": "/manuals/debugging-game-logic/#running-the-debugger",
"name": "Debugger"
},
{
"path": "/manuals/editor-keyboard-shortcuts",
"name": "Keyboard shortcuts"
},
{
"path": "/manuals/editor-preferences",
"name": "Preferences"
Expand Down
137 changes: 0 additions & 137 deletions docs/en/manuals/editor-keyboard-shortcuts.md

This file was deleted.

24 changes: 20 additions & 4 deletions docs/en/manuals/editor-preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@ Track Active Tab in Asset Browser
Lint Code on Build
: Enables [code linting](/manuals/writing-code/#linting-configuration) when the project is built. This option is enabled by default, but can be disabled if the linting in a large project takes too much time.

Path to custom keymap
: Absolute path to a file containing [custom keyboard shortcuts](/manuals/editor-keyboard-shortcuts).

Engine Arguments
: Arguments that will be passed to the dmengine executable when the editor builds and runs.
Use one argument per line. For example:
Expand All @@ -58,6 +55,9 @@ Open File at Line
Code editor font
: Name of a system installed font to use in the code editor.

Zoom on Scroll
: Whether to change the font size when scrolling in the code editor while holding Cmd/Ctrl button.


### Open script files in Visual Studio Code

Expand All @@ -84,6 +84,12 @@ The `.` character here is required to open the entire workspace, not an individu
Build Server
: URL to the build server used when building a project containing [native extensions](/manuals/extensions). It is possible to add a username and access token to the URL for authenticated access to the build server. Use the following notation to specify the username and access token: `username:[email protected]`. Authenticated access is required for Nintendo Switch builds and when running your own build server instance with authentication enabled ([refer to the build server documentation](https://github.com/defold/extender/blob/dev/README_SECURITY.md) for more information). The username and password can also be set as the system environment variables `DM_EXTENDER_USERNAME` and `DM_EXTENDER_PASSWORD`.

Build Server Username
: username for authentication.

Build Server Password
: password for authentication, will be stored encrypted in the preferences file.

Build Server Headers
: additional headers to the build server when building native extensions. It's important for using CloudFlare service or similar services with extender.

Expand All @@ -95,4 +101,14 @@ ADB path
: Path to [ADB](https://developer.android.com/tools/adb) command line tool installed on this system. If you have ADB installed on your system, the Defold editor will use it to install and run bundled Android APKs to a connected Android Device. By default, the editor checks if ADB is installed in well-known locations, so you only need to specify the path if you have ADB installed in a custom location.

ios-deploy path
: Path to [ios-deploy](https://github.com/ios-control/ios-deploy) command line tools installed on this system (only relevant for macOS). Similarly to the ADB path, the Defold editor will use this tool to install and run bundled iOS applications on a connected iPhone. By default, the editor checks if ios-deploy is installed in well-known locations, so you only need to specify the path if you use a custom installation of ios-deploy.
: Path to [ios-deploy](https://github.com/ios-control/ios-deploy) command line tools installed on this system (only relevant for macOS). Similarly to the ADB path, the Defold editor will use this tool to install and run bundled iOS applications on a connected iPhone. By default, the editor checks if ios-deploy is installed in well-known locations, so you only need to specify the path if you use a custom installation of ios-deploy.

## Keymap

![](images/editor/preferences_keymap.png)

You can configure the editor shortcuts, both adding custom and removing the built-in ones. Use context menu on individual commands in the shortcut table to edit the shortcuts, or double-click/press <kbd>Enter</kbd> to open a new shortcut popup.

Some shortcuts might have warnings: they are displayed using orange color. Hover over the shortcut to see the warning. Typical warnings are:
- typeable shortcuts: the selected shortcut is typeable in a text inputs. Make sure the command is off in the code editing / text input contexts.
- conflicts: the same shortcut is assigned to multiple different commands. Make sure at most one command is enabled when the shortcut is invoked, otherwise the editor will execute one of the assigned commands in an undefined manner.
4 changes: 0 additions & 4 deletions docs/en/manuals/editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,6 @@ The editor will automatically check for updates. When an update is detected it w

You can modify the settings of the editor [from the Preferences window](/manuals/editor-preferences).

## Keyboard shortcuts

Keyboard shortcuts and how to customize them can be seen in the [keyboard shortcut manual](/manuals/editor-keyboard-shortcuts).

## Editor logs
If you run into a problem with the editor and need to [report an issue](/manuals/getting-help/#getting-help) it is a good idea to provide log files from the editor itself. The editor logs files can be found here:

Expand Down
Binary file modified docs/en/manuals/images/editor/preferences_code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/manuals/images/editor/preferences_extensions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/manuals/images/editor/preferences_general.png
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.
Binary file modified docs/en/manuals/images/editor/preferences_tools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading