A 3d realtime visualizer for Dwarf Fortress.
Want to help out? We love contributions!
If you've run into any bugs: report them! (You'll need a github account.) Make sure to describe the issue in as much detail as you can, and to mention what system & Armok Vision version you're using. Also, check if what you're reporting has been reported before.
If you're an artist and want to contribute 3D models, sounds, concept art:
StreamingAssets
somewhere around the armok vision executable (or inside, if you're on a mac.) If you edit the files inside and restart Armok Vision, it will use your modified assets. Be careful editing the .xml files, they're finnicky. You can post your edited resources in the forum thread and we can try to integrate them with the project.If you know how to code and want to hack on the engine:
git lfs version
).$ git clone --recurse-submodules --depth 1 https://github.com/JapaMala/armok-vision.git
(or without --depth 1
if you want the full history, but it's pretty big).armok-vision
folder in the Unity editor.Mytools->Build Material Collection
menu item. This is required after a fresh pull from Git, as well as after changing any material files. If you want to buy the lead programmer a snack, you can donate on his Patreon Page
(Some short notes for anyone getting started with the codebase.)
GameObject
s representing different map chunks. It calls the scripts in Assets/Scripts/MapGen/Meshing to build the actual meshes (on separate threads).There's a lot of other stuff but hopefully it'll be reasonably self-explanatory. Alternatively, you can ask in the forum thread, or the #dfhack IRC channel on freenode; somebody might be lurking who can help.