Skip to content

Commit

Permalink
Update the Natlink engine documentation page
Browse files Browse the repository at this point in the history
Re: #341, #351.

- Update Natlink SourceForge link.
- Make the section on command-modules clearer.
  • Loading branch information
drmfinlay committed Sep 12, 2022
1 parent 64df79d commit 62ee214
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions documentation/natlink_engine.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Natlink and DNS engine back-end

Dragonfly uses Natlink to communicate with Dragon. The latest versions of
Natlink are available from `SourceForge
<https://sourceforge.net/projects/natlink/files/natlink/natlinktest4.1/>`__.
<https://sourceforge.net/projects/natlink/files/natlink/natlink4.2/>`__.
All versions in the 4.X range should work with Dragonfly. Please see the
`Natlink install instructions
<https://qh.antenna.nl/unimacro/installation/index.html>`__ on
Expand All @@ -29,12 +29,15 @@ optional user directory. Common locations are:
* ``C:\Program Files\NatLink\MacroSystem``
* ``My Documents\Natlink``

At least one of these should be present after installing
Natlink. That is the place where you should put Dragonfly
command-modules so that Natlink will load them. Don't forget to
turn the microphone off and on again after placing a new
command-modules in the Natlink directory, because otherwise
Natlink does not immediately see the new file.
At least one of these, or the custom user directory, should be present
after installing and configuring Natlink. That is the place where you
should put Dragonfly command-modules so that Natlink will load them.
Command-modules should be Python source files starting with an underscore,
e.g. *_notepad_example.py*.

Don't forget to turn the microphone off and on again after placing new
command-modules in the Natlink directory, because otherwise Natlink does
not immediately see the new file.


Engine Configuration
Expand Down

0 comments on commit 62ee214

Please sign in to comment.