Skip to content

Commit

Permalink
Update readme with new keyboard shortcuts
Browse files Browse the repository at this point in the history
  • Loading branch information
leecbaker committed Apr 21, 2021
1 parent 4cff2aa commit 145de6b
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,37 @@ To install the plugin, download the latest release [on this page](https://github

Glad you asked!

In general, normal text editing shortcuts are respected:

* Ctrl-X / ⌘-X : cut
* Ctrl-C / ⌘-C : copy
* Ctrl-V / ⌘-V : paste
* Ctrl-A / ⌘-A : select all

These only work while an edit field is selected. If you want additional keyboard shortcuts (to open a search window, for instance) these can be added by searching for "datareftool" in X-Plane's keyboard settings.
In the search window, there are some additional things you can do:

* Ctrl-N / ⌘-N : open a new search window
* Ctrl-W / ⌘-W : close current window
* Tab / shift-tab : switch between search field and results

Search field:

* Ctrl-F / ⌘-F or Ctrl-L / ⌘-L : go to the search field
* Ctrl-alt-C / ⌥⌘-C : Toggle Change detection
* Ctrl-alt-I / ⌥⌘-I : Toggle case-Insensitive search
* Ctrl-alt-R / ⌥⌘-R : Toggle Regex search
* Ctrl-alt-S / ⌥⌘-S : Toggle Source (dataref/command/all)

Search results:

* Enter/return : open details window for the current dataref/command
* Ctrl-C / ⌘-C: Copy currently-selected dataref name
* Ctrl-alt-C / ⌘⌥-C : Copy currently-selected dataref value
* Type a number : Set new value for currently-selected scalar dataref (int/float/double only)
* Space: activate current command
* J/K or up/down arrow : Go up or down in the list (like vim)

If you want additional keyboard shortcuts (to open a search window, for instance) these can be added by searching for "datareftool" in X-Plane's keyboard settings.

### FAQ: DRT can't find my dataref

Expand All @@ -59,7 +84,19 @@ DRT scans files to find datarefs. This might not work if your dataref is in an e

DRT reads every dataref published by every aircraft and plugin, on every frame of the simulation. Sometimes, they haven't fully been debugged, and may crash. (If you're a developer, the best way to do this is to run X-Plane in a debugger and look at the backtrace of the crash- if you see RefRecords::update() in the backtrace, this is likely what happened.)

If you can figure out which dataref caused the crash, the best way to work around this is to add the name of the dataref to a file called "drt_ignore.txt" in the Resources/plugins directory. This will cause DRT to never read the value of the dataref, even if it does come up in search results.
If you can figure out which dataref caused the crash, the best way to work around this is to add the name of the dataref to a file called `X-Plane 11/Resources/plugins/drt_ignore.txt`. This will cause DRT to never read the value of the dataref, even if it does come up in search results.

### FAQ: Using DRT with the Bell 407 causes X-Plane to crash

If you're flying the Bell 407, there is a known issue with this aircraft where reading some datarefs triggers an immediate crash. To work around this, create a file called `X-Plane 11/Resources/plugins/drt_ignore.txt`, and add the following lines to the file:

```txt
B407/Lights/CL1
B407/Lights/CL2
B407/Lights/CL3
```

The Bell 407 problem is being tracked in issue #33 in this repository.

### FAQ: DataRefTool causes me to loose FPS! Why?

Expand Down

0 comments on commit 145de6b

Please sign in to comment.