Merge pull request #578 from niftools/develop for version 0.1.0

Author: Candoran2

.idea/misc.xml

@@ -18,13 +18,14 @@ Contributors
 ------------
 
 * Aaron1178
+* Allofich
 * Alphax
 * Arcimaestro
 * Arthmoor
 * Artorp
-
 * Deedes
 * Eli2
+* enpinion
 * Entim
 * Eugenius-v
 * Fritz_fretz
@@ -37,11 +38,13 @@ Contributors
 * mgm101
 * opusGlass
 * Pacificmorrowind
+* paulgreenG
 * Pentinen
 * @reddraconi
 * shon
 * @SubhadeepG
 * @TagnumElite
+* TackYs
 * Tamira
 * Thedaywalker
 * Tijer

AUTHORS.rst

@@ -1,3 +1,36 @@
+Version v0.1.00
+===============
+
+- #576 Updates to documentation, changelog and makezip.bat (copies over generated folder from cobra-tools).
+- #572 Extra development of NiMesh import and some fixes
+    - Fix to BSInvMarker rotation export.
+    - Fix for bs_data_flags setting in export - now also applied to other games where applicable, not just Skyrim.
+    - Fix to transform on packed collision vertices export.
+    - Adjust StringProperty arguments to prevent crash in Blender 3.2 or lower.
+    - Fix to mistake in BhkMalleableConstraint info import.
+    - Added processing of regions to NiMesh bone import.
+    - Basic DisplayList import (NiMesh with a specific type of datastream, which encodes the geometry). Bone weights for this type of nif are still unimplemented.
+- #543 Use "Color" type for "InvertY" group
+- #541 NiMesh import and updates for newer xml
+    - Nif file glob now partially dependent on xml.
+    - Support for NiMesh import (except those using DisplayList).
+    - Support for BSDynamicTriShape import.
+    - Update to Object properties ui (now only show relevant properties)
+    - Closes #533 "Unknown block type BSDynamicTriShape".
+    - Closes #421 "Can't import catherine classic .nif files."
+- #535 Pyffi overhaul
+    - Change kf and nif import to make use of the new statically generated nif reading/writing library.
+    - Added support for SSE mesh import.
+    - Closes #521.
+- #526 Allow setting armature axis manually
+- #524 int cast in add_dummy_markers to comply with blender 3.1+'s python and check for interpolator attribute on controller before accessing it.
+- #506 Speedup anim import & various other fixes
+    - Closes #180
+    - Closes #495
+    - Closes #500
+    - Closes #510
+    - Closes #517
+
 Version v0.0.14
 ===============
 

CHANGELOG.rst

@@ -94,3 +94,15 @@ Vertex Color & Alpha
 * `This image should clarify per-face vertex colouring
   <http://i211.photobucket.com/albums/bb189/NifTools/Blender/documentation/per_face_vertex_color.jpg>`_
 * On export, the scripts will create extra vertices for different vertex colors per face.
+
+
+.. _geometry-shapekeys:
+
+Shape Key Animations
+--------------------
+
+**Example:**
+
+#. :ref:`Create a mesh-object <geometry-mesh>`.
+#. Add relative shape keys to your mesh.
+#. Keyframe each shape key's value so that the key influences the shape of the mesh at the desired time.

docs/user/features/geometry/geometry.rst

@@ -122,8 +122,8 @@ First, we complete the object panel:
 #. Set your **BSX Flags**.
 #. Select a **Consistency Flag** from the drop-down box. See `this comment
    <https://github.com/niftools/nifskope/issues/69#issuecomment-61427385>`_ for discussion of what they might do.
-#. The **Object Flag** is ???????. Set it to an appropriate number.
-#. The **Nif Long Name** is ???????. Set it to an appropriate string.
+#. The **Object Flag** corresponds to the flags field on NiAVObjects. The exact meaning will differ based on the block type. Set it to an appropriate number. If left to 0, will use a default value.
+#. The **Nif Long Name** is the actual name used for the corresponding block in the nif. You can either set it to an appropriate string, or leave it empty. In the latter case, the nif name will be determined based on the blender name of the object.
 #. The **Skeleton Root** determines the root bone used in this mesh's SkinInstance. Can usually be ignored / left empty, falls back to the armature object = root node.
 
 .. Extra Data and InvMarkers I have no idea how to fill them in. Help?

docs/user/features/object/index.rst

@@ -26,11 +26,26 @@ mkdir "%DEPS%"
 
 python -m pip install "PyFFI==%PYFFI_VERSION%" --target="%DEPS%"
 
+xcopy "%GENERATED_FOLDER%" "%DEPS%\generated" /s /q /i
+
 xcopy "%ROOT%"\AUTHORS.rst io_scene_niftools
 xcopy "%ROOT%"\CHANGELOG.rst io_scene_niftools
 xcopy "%ROOT%"\LICENSE.rst io_scene_niftools
 xcopy "%ROOT%"\README.rst io_scene_niftools
+
+:: remove all __pycache__ folders
+for /d /r %%x in (*) do if "%%~nx" == "__pycache__" rd %%x /s /q
+
 popd
 
-powershell -executionpolicy bypass -Command "%DIR%\zip.ps1" -source "%DIR%\temp\io_scene_niftools" -destination "%DIR%\%ZIP_NAME%.zip"
-rmdir /s /q %DIR%\temp
+set "COMMAND_FILE=%DIR%\zip.ps1"
+set "COMMAND_FILE=%COMMAND_FILE: =` %"
+
+set "SOURCE_DIR=%DIR%\temp\io_scene_niftools"
+set "SOURCE_DIR=%SOURCE_DIR: =` %"
+
+set "DESTINATION_DIR=%DIR%\%ZIP_NAME%.zip"
+set "DESTINATION_DIR=%DESTINATION_DIR: =` %"
+
+powershell -executionpolicy bypass -Command "%COMMAND_FILE%" -source "%SOURCE_DIR%" -destination "%DESTINATION_DIR%"
+rmdir /s /q "%DIR%\temp"

install/makezip.bat

@@ -1 +1 @@
-v0.0.14
+v0.1.0

io_scene_niftools/VERSION.txt

@@ -49,7 +49,7 @@
     "description": "Import and export files in the NetImmerse/Gamebryo formats (.nif, .kf, .egm)",
     "author": "Niftools team",
     "blender": (2, 82, 0),
-    "version": (0, 0, 14),  # can't read from VERSION, blender wants it hardcoded
+    "version": (0, 1, 0),  # can't read from VERSION, blender wants it hardcoded
     "api": 39257,
     "location": "File > Import-Export",
     "warning": "Generally stable port of the Niftool's Blender NifScripts, many improvements, still work in progress",
@@ -72,8 +72,8 @@ def locate_dependencies():
 
     with open(os.path.join(current_dir, "VERSION.txt")) as version:
         NifLog.info(f"Loading: Blender Niftools Addon: {version.read()}")
-        import pyffi
-        NifLog.info(f"Loading: PyFFi: {pyffi.__version__}")
+        import generated.formats.nif as NifFormat
+        NifLog.info(f"Loading: NifFormat: {NifFormat.__xml_version__}") # todo [generated] update this and library to have actual versioning
 
 
 locate_dependencies()

io_scene_niftools/__init__.py

@@ -37,8 +37,9 @@
 #
 # ***** END LICENSE BLOCK *****
 
+import os.path as path
 
-from pyffi.formats.nif import NifFormat
+import generated.formats.nif as NifFormat
 
 from io_scene_niftools.utils.logging import NifLog, NifError
 
@@ -51,18 +52,18 @@ def load_nif(file_path):
         """Loads a nif from the given file path"""
         NifLog.info(f"Importing {file_path}")
 
-        data = NifFormat.Data()
+        file_ext = path.splitext(file_path)[1]
 
         # open file for binary reading
         with open(file_path, "rb") as nif_stream:
             # check if nif file is valid
-            data.inspect_version_only(nif_stream)
-            if data.version >= 0:
+            modification, (version, user_version, bs_version) = NifFormat.NifFile.inspect_version_only(nif_stream)
+            if version >= 0:
                 # it is valid, so read the file
-                NifLog.info(f"NIF file version: {data.version:x}")
-                NifLog.info("Reading file")
-                data.read(nif_stream)
-            elif data.version == -1:
+                NifLog.info(f"NIF file version: {version:x}")
+                NifLog.info(f"Reading {file_ext} file")
+                data = NifFormat.NifFile.from_stream(nif_stream)
+            elif version == -1:
                 raise NifError("Unsupported NIF version.")
             else:
                 raise NifError("Not a NIF file.")