Readme File lacks install instructions

[Rydelfox]

The biggest thing I was looking for in the readme file was installation instructions, since it doesn't look like I would just drop everything in the Dwarf Fortress root folder, but that seems to be missing from the readme file.

[Lucatir]

The readme states that TWBT is a DFHack plugin thus you should consult the DFHack readme/forum thread. DFHack and its plugins are advanced tools thus advanced computer literacy and some effort is expected from the users.

However, including this information would definitely not hurt either and might be advisable considering DFHack is also included in many if not all "newbie packages" of Dwarf Fortress..

If you still don't know how to install DFHack plugins, you simply put the .dll files to /hack/plugins. Obviously you need DFHack installed. The rest is pretty straight forward and included in the readme.

Some/most DFHack plugins need to be loaded by dfhak.init or invoked from DFHack console, but TWBT is an exception (unless you want to alter tilesize on the fly which requires the use of the console) as you need to only set the print mode in the init.txt. I don't know how this actually works in practice.

[belug23]

You should add a install section that state:

For install instruction please refer to DFHack

this would help a lot for new players.

Thanks

[pronvit]

Thanks, I'll consider doing that. Most people are getting this plugin as part of a df+dfhack pack, I didn't think many people were coming here not knowing about dfhack.

[txtsd]

@pronvit It would definitely help!

[lethosor]

@ErdeFB TwbT comes with several more non-plugin files that need to be moved to specific places, so the DFHack instructions for installing plugins (if there are any besides "copy the plugin into the plugins folder") wouldn't be helpful. (Also, the plugin is only a .dll file on Windows - the extension is .dylib on OS X and .so on Linux.)

[ghost]

@lethosor ErdeFB's comment was a little condescending. If you ordered some parts that required construction and didn't get a manual, it would be rather ridiculous if the company said "advanced DIY literacy and some effort is expected from our customers". It doesn't take advanced computer literacy to put files in the correct folders. But it's not at all clear what files should be put where, what they're needed for or if they can be replaced (when installing a graphics pack) and TWBT will still work correctly.

I for one would like to see install instructions sooner than later.

[lethosor]

What I meant was that referring people to DFHack's plugin installation instructions isn't helpful because there aren't any (since all DFHack plugins come with DFHack), and even if there were, TwbT has a significantly more involved installation process than most plugins. I agree that installation instructions would be helpful. That seemed reasonable enough to me, so I'm not sure why you deleted your account.

[astradamus]

It strikes me as odd that this has been an issue for nearly 3 years? In case some future 'computer illiterate' and 'lazy' soul like myself finds themselves on this page after plying Google for answers, here's the ridiculously simple yet mysteriously ineffable instructions you seek:

0) Override any conflicts presented by the following steps. 1) Extract DLLs to hack/plugins. If your package includes multiple sets of DLLs, make your best guess as to which is newest (betas tend to come after alphas, higher numbers imply newer versions, etc.) and use that one. 2) Extract PNGs to data/art. 3) Extract LUA to hack/lua. 4) Extract "overrides.txt" to data/init.