daenor / masterwork-dwarf-fortress

Patches and bugfixes applied to Meph's amazing Masterwork Dwarf Fortress

«☼Masterwork Dwarf Fortress - Studded with Patches☼»

This is a community driven branch of Meph's excellent Masterwork Dwarf Fortress.

Playing

If all you want to do is play, you can download one of two ready-to-go zip files:

• The master release contains all bugfixes and improvements which are considered stable. It is always based upon the most recently release of Masterwork Dwarf Fortress.

• The unified release is the same as the master release, but also includes experimental features and bugfixes. Things don't get placed into unified until we're pretty sure they work, so it's recommended for most users, but occasionally things will still be a bit rough around the edges.

If you already have the latest release of Dwarf Fortress, you can download patch files should update your distributions to the Studded With Patches versions of the files. These are automatically generated, and are not guaranteed to work. If in doubt, use the zips above:

• master release (patches only)
• unified release (patches only)

Reporting bugs

Please report bugs in the issues tracker. Please try to be as specific as possible.

Contributing

1. Set up git
2. Fork this repo and then clone it to your local machine.
3. Make your changes.
4. Commit them (git add the files that have changed, git commit them, and then git push them back to github).
5. Submit a pull request, or point me to your changes on the forum
6. Celebrate, because you're awesome!

If you're an advanced git user, you're encouraged to use feature branches if you're going to be making a lot of related changes. Likewise we suggest you make your changes based upon master, or a feature branch your changes depend upon (like dfhack_r4), as the unified branch is really just an amalgan of features, rather than a proper development branch in and of itself.

If you're still new to git, don't worry about the preceeding paragraph. Just do what feels best; git makes it easy to apply patches to the right place. However we do encourage you to commit early and often; little commits each making a set of related changes are easier to manage than larger commits which may involve changing different features.

More information

If you want to discuss this project, please use the thread on the Dwarf Fortress message boards. The Masterwork Dwarf Fortress boards may also be useful.