Merge branch 'master' into develop

Conflicts:
	docs/Introduction.rst - GitHub mention added manually to Support.rst
develop
lethosor 2021-06-15 00:40:42 -04:00
commit a938aa14a5
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
3 changed files with 38 additions and 26 deletions

@ -60,29 +60,6 @@ used by the DFHack console.
background managing or changing some aspect of the game if you `enable` them. background managing or changing some aspect of the game if you `enable` them.
.. _troubleshooting: Getting help
.. _support: ============
There are several support channels available - see `support` for details.
Troubleshooting
===============
Don't panic! Even if you need this section, it'll be OK :)
If something goes wrong, check the log files in DF's folder
(``stderr.log`` and ``stdout.log``). Looking at these might help you -
or someone else - solve the problem. Take screenshots of any weird
error messages, and take notes on what you did to cause them.
If the search function in this documentation isn't enough and
:wiki:`the DF Wiki <>` hasn't helped, try asking in:
- the `#dfhack IRC channel on freenode <https://webchat.freenode.net/?channels=dfhack>`_
- the `Bay12 DFHack thread <https://dfhack.org/bay12>`_
- on GitHub:
- for bugs, use the :issue:`issue tracker <>`
- for more open-ended questions, use the `discussion board
<https://github.com/DFHack/dfhack/discussions>`__. Note that this is a
relatively-new feature as of 2021, but maintainers should still be
notified of any discussions here.
- the `/r/dwarffortress <https://dwarffortress.reddit.com>`_ questions thread
- the thread for the mod or Starter Pack you're using (if any)

@ -0,0 +1,34 @@
.. _support:
===============
Getting Support
===============
DFHack has several ways to get help online, including:
- The `DFHack Discord server <https://dfhack.org/discord>`__
- The ``#dfhack`` IRC channel on `Libera <https://libera.chat/>`__
- GitHub:
- for bugs, use the :issue:`issue tracker <>`
- for more open-ended questions, use the `discussion board
<https://github.com/DFHack/dfhack/discussions>`__. Note that this is a
relatively-new feature as of 2021, but maintainers should still be
notified of any discussions here.
- The `DFHack thread on the Bay 12 Forum <https://dfhack.org/bay12>`__
Some additional, but less DFHack-specific, places where questions may be answered include:
- The `/r/dwarffortress <https://dwarffortress.reddit.com>`_ questions thread on Reddit
- If you are using a starter pack, the relevant thread on the `Bay 12 Forum <http://www.bay12forums.com/smf/index.php?board=2.0>`__ -
see the :wiki:`DF Wiki <Utility:Lazy_Newb_Pack>` for a list of these threads
When reaching out to any support channels regarding problems with DFHack, please
remember to provide enough details for others to identify the issue. For
instance, specific error messages (copied text or screenshots) are helpful, as
well as any steps you can follow to reproduce the problem. Sometimes, log output
from ``stderr.log`` in the DF folder can point to the cause of issues as well.
Some common questions may also be answered in documentation, including:
- This documentation (`online here <https://dfhack.readthedocs.io>`__; search functionality available `here <search>`)
- :wiki:`The DF wiki <>`

@ -28,6 +28,7 @@ User Manual
/docs/Introduction /docs/Introduction
/docs/Installing /docs/Installing
/docs/Support
/docs/Core /docs/Core
/docs/Plugins /docs/Plugins
/docs/Scripts /docs/Scripts