I have an enormous love for Dwarf Fortress and for its mods. In the years I've been playing and following this game, I think that there's always been a gap where a really powerful raws mod manager could be. This is the niche PyDwarf is intended to fill: I want to give mod authors the power to access and modify Dwarf Fortress's files with an elegance hitherto unseen, and I want to give users the ability to apply these mods with a minimum of effort.
PyDwarf is licensed via the exceptionally permissive zlib/libpng license. It's written for Python 2.7 and is intended as a mod tool for the wonderful game Dwarf Fortress.
PyDwarf is easy to configure! Open config.yaml with your favorite plain text editor and tell it where to find your Dwarf Fortress raws, edit the list of scripts to reflect the mods you want to run and in what order you'd like them to run. Once the configuration is to your liking you can run manager.py: With Python 2.7 installed this can be done by opening a command line in the PyDwarf directory and running python manager.py.
Here's a step-by-step tutorial describing what this process might entail your first time around, here's detailed documentation on how to configure PyDwarf, and here's a full list of scripts which come bundled with PyDwarf.
If you're interested in writing your own mods for PyDwarf or in understanding its more advanced features, take a look at this tutorial, which goes into detail about how to write mods using PyDwarf.
- Download and install Python 2.7
- Series of Python tutorials
- Tutorial for your first time using PyDwarf
- Tutorial for getting started modding with PyDwarf
- Documentation for advanced configuring of PyDwarf
- Documentation for PyDwarf's Python code
- Documentation for scripts packaged with PyDwarf
- Issue tracker on GitHub
- PyDwarf on the Bay12 forums
