Armok Vision

The package contains several low-poly boat meshes that function as simple props. They can be used as secondary side assets or as primary assets within Unity games and applications.

Available Meshes:
- Birda
- Black Pearl
- Speedy
- Super Sail
- Tiny
- White Fang

Included Assets:
- Texture: boat_texture.png
- Material: boat_material

Artists can contribute assets in two ways:

Method 1: Direct File Editing

Locate the StreamingAssets folder near the Armok Vision executable (or inside the app bundle on macOS). You can edit files directly in this folder and restart Armok Vision to see changes. Note: Be careful when editing .xml files as they are sensitive to formatting errors.

Method 2: Unity Editor

Load the project assets into Unity and edit them there using the standard Unity workflow.

Use the following keyboard and mouse controls to navigate and interact with the Armok Vision interface:

Movement & View

• Horizontal Movement: W, A, S, D, or middle-click drag.
• Vertical Movement: Q or E.
• Zoom: Mouse wheel.
• Rotation: Right-click drag.
• Follow Center: F (toggles following the center of the Dwarf Fortress screen).

Time & Environment

• Sun Movement: P (pauses/resumes sun movement).
• Time of Day: [ or ] (changes time of day; automatically pauses sun movement).
• Shadows: O (toggles shadows cast from hidden Z-levels).

Display & Interface

• Creature Scaling: L (toggles scaling of creatures based on size).
• Dwarf Fortress Screen: ` (toggles showing the DF screen).
• Options Menu: Esc.

Screenshots

• Full Screenshot: F9.
• Minimap: Ctrl+F9.

OBJ-IO provides functionality to import and export OBJ files. The core Import and Export functions are designed to be flexible by accepting a System.IO.Stream as a parameter, allowing you to read from or write to files, memory streams, or other stream-based sources.

Note: The current implementation only supports geometry data; it does not support materials or other non-geometric OBJ data.

// The API uses System.IO.Stream for flexibility
// Example conceptual usage:
// Import(Stream stream)
// Export(Stream stream, geometryData)

To use the censor effect in your scene, create a new 3D object (such as a Quad) and assign the CensorEffectMat material to it. While a Quad is the standard starting point, the effect can be applied to any mesh.

1. GameObject -> 3D Object -> Quad
2. Assign "CensorEffectMat" material to the object

To install Armok Vision, you must have a copy of Dwarf Fortress with a recent build of DFHack installed.

For full functionality, ensure you have one of the following:

1. A version of DFHack built after the current Armok Vision release.
2. An updated RemoteFortressReader plugin for your specific platform.

If neither is available, you must build DFHack yourself from the develop branch following the DFHack compilation guide.

To contribute to the codebase, you need to set up a Unity-based development environment:

1. Install Unity 5.
2. For non-Windows users, install the Git LFS extension (verify with git lfs version).
3. Clone the repository including submodules:

   git clone --recurse-submodules --depth 1 https://github.com/JapaMala/armok-vision.git

4. Open the armok-vision folder in the Unity editor.
5. Crucial Step: Run the Mytools -> Build Material Collection menu item in Unity. This is required after a fresh pull or after modifying any material files.

The core logic for the OBJ-IO plugin is located in the following directories within the project:

• OBJ-IO/Plugins/OBJ
• OBJ-IO/Plugins/Extension