Example images to go along with the example config

[mkaito]

It's really nice that one can build their own config by editing the json files, but without some example images, it's laborious to figure out how to use it.

I suggest you include one or a few sample images that use your sample config.

[Hrothen]

That's a good idea, I was planning to spend some time updating this project over the holidays already, and I can definitely add some examples.

[mkaito]

Also, it's worth considering that a standard configuration allows for image plans to be easily shared among users, or even for setting up a shared online repository. They are images, which makes them easy to render online for preview.

This might belong in another issue, but how about keeping the default configuration in whatever system folder is adequate for the platform (/usr/lib/dorfcad on Linux, for example), and allowing the user to keep an override somewhere else (~/.config/dorfcad on Linux, for example). This kind of thing is fairly standard on Linux. I have no idea about Windows, but putting everything in a zipfile and keeping it in the same folder would likely work just fine, and users would probably simply edit that file.

For this to be useful, dorfcad would have to first load the default config, and then load the user config, which might contain only a few keys the user wants added/changed from the default.

Also, do you happen to know whether the output csv files are compatible with the dfhack buildfort and fortplan plugins?

[Hrothen]

This is actually already implemented in the 1.3 branch, it uses the paths generated by cabal-install which is something like /usr/local/.cabal/dorfCAD/ on linux, and then looks for files named aliases, aliases-user, config, and config-user. I think right now it just uses the user files instead of the default if it finds one though.

It looks like the output files should also be compatible with buildfort and fortplan, those plugins are supposed to be compatible with quickfort blueprints.

[mkaito]

The user is not meant to write their personal stuff to /usr, since files installed there are expected to be overwritten with package updates. The norm is to use a $XDG_CONFIG_HOME/<program/ folder, where $XDG_CONFIG_HOME should default to ~/.config/. I'm not sure cabal handles that for you.

Either way, with the idea of using a more complete standard configuration, this concern is somewhat secondary, but still useful for someone who makes extensive usage of dorfcad, since it makes it very easy for him to keep personal additions and changes separate from the distributed config.