https://github.com/Dwarf-Therapist/Dwarf-Therapist

Dwarf management tool for Dwarf Fortress
https://github.com/Dwarf-Therapist/Dwarf-Therapist

Last synced: 3 months ago
JSON representation

Dwarf management tool for Dwarf Fortress

• Host: GitHub
• URL: https://github.com/Dwarf-Therapist/Dwarf-Therapist
• Owner: Dwarf-Therapist
• License: other
• Created: 2017-09-17T15:14:58.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-04T16:16:04.000Z (7 months ago)
• Last Synced: 2024-05-04T17:27:58.229Z (7 months ago)
• Language: C++
• Size: 32.4 MB
• Stars: 612
• Watchers: 44
• Forks: 57
• Open Issues: 46
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.txt
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
===============

Dwarf Therapist

===============

This is the maintained version of `Splintermind's Dwarf Therapist`_ (itself a heavily modified version of the `original Dwarf Therapist`_).

The Dwarf Therapist guide source and releases have `their own repository `_.

Latest Release

========

The `latest release`_ is always published in the project's `releases`_ page. These releases normally contain packages for Windows, OSX, and Linux.

Alternate Download (DFFD)

-------------------------

If the latest published releases do not contain a package, they may be found on DFFD.

`Windows 32-bit `_

`Windows 64-bit `_

The manual for Dwarf Therapist can be downloaded separately.

`Stand-alone Manual `_

Building

========

Dwarf-Therapist requires a C++ compiler (with C++14 support), cmake (3.1.0 or newer), and Qt5 (5.9 or newer, with Widgets and QML and Network modules).

Detailed building instructions can be found in `BUILDING.md`_.

Linux

=====

In addition to the AppImage provided on the `releases`_ page, packages for specific distributions can be found at:

- `COPR repository`_ for Fedora users.

- `AUR package`_ for Arch users.

Some Linux distributions restrict the ability to trace other processes. If Dwarf Therapist fails to connect to Dwarf Fortress, check `ptrace_scope help`_.

Support

=======

Primary support is available at the `Dwarf Therapist thread`_ at the Bay 12 Forums; if you are sure you have found a bug, file an issue at the `GitHub issue tracker`_.

Provide as much information as possible to help reproduce the issue.

Most runtime bugs will require you to send a save, preferably uploaded at `DFFD`_.

You may also be requested to provide a log, which is saved in ``log/log.txt`` on Windows and OSX and output to stderr on Linux systems (use ``2> log.txt`` to collect).

You can also join us in `#dwarftherapist on Freenode`_.

.. _Splintermind's Dwarf Therapist: https://github.com/splintermind/Dwarf-Therapist/

.. _original Dwarf Therapist: http://code.google.com/p/dwarftherapist/

.. _BUILDING.md: https://github.com/Dwarf-Therapist/Dwarf-Therapist/blob/master/BUILDING.md

.. _ptrace_scope help: https://github.com/Dwarf-Therapist/Dwarf-Therapist/blob/master/dist/ptrace_scope/README.md

.. _Yama ptrace LSM: https://www.kernel.org/doc/Documentation/security/Yama.txt

.. _Dwarf Therapist thread: http://www.bay12forums.com/smf/index.php?topic=168411

.. _GitHub issue tracker: https://github.com/Dwarf-Therapist/Dwarf-Therapist/issues

.. _DFFD: http://dffd.wimbli.com/category.php?id=20

.. _#dwarftherapist on Freenode: http://webchat.freenode.net/?channels=%23dwarftherapist

.. _releases: https://github.com/Dwarf-Therapist/Dwarf-Therapist/releases

.. _latest release: https://github.com/Dwarf-Therapist/Dwarf-Therapist/releases/latest

.. _COPR repository: https://copr.fedorainfracloud.org/coprs/cvuchener/Dwarf-Therapist/

.. _AUR package: https://aur.archlinux.org/packages/dwarftherapist/