Refer to server config docs from dfhack-run

develop
lethosor 2020-07-21 23:14:59 -04:00
parent b34aa86d3c
commit dfc9f78fa4
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
2 changed files with 11 additions and 1 deletions

@ -82,7 +82,7 @@ dfhack-run
If DF and DFHack are already running, calling ``dfhack-run my command``
in an external terminal is equivalent to calling ``my command`` in the
DFHack console. Direct use of the DFhack console is generally easier,
DFHack console. Direct use of the DFHack console is generally easier,
but ``dfhack-run`` can be useful in a variety of circumstances:
- if the console is unavailable
@ -101,6 +101,14 @@ Examples::
The first (\*nix) example `checks for vampires <cursecheck>`; the
second (Windows) example uses `kill-lua` to stop a Lua script.
.. note::
``dfhack-run`` attempts to connect to a server on TCP port 5000. If DFHack
was unable to start this server, ``dfhack-run`` will not be able to connect.
This could happen if you have other software listening on port 5000, or if
you have multiple copies of DF running simultaneously. To assign a different
port, see `remote-server-config`.
Built-in Commands
=================

@ -16,6 +16,8 @@ available are not comprehensive, but can be extended with plugins.
:local:
.. _remote-server-config:
Server configuration
====================