Skip to content

Commit

Permalink
release: 1.0.0 - update version number and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alinsavix committed Jun 5, 2021
1 parent a3f99f3 commit e36c5c4
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ TL;DR: This Blender add-on + WoW.Export = Streamlined material assignment with a
- Automatically sets up UV animations (for magic effects, etc.) to animate in the correct ways, with correct timings
- Can create node trees based on emissive shaders (most true to WoW), diffuse shaders, specular shaders, or the principled shader


### Current Non-features/Mis-features

- For full functionality, you will need to export the model from wow.export twice (see "Using")
Expand All @@ -25,6 +26,7 @@ TL;DR: This Blender add-on + WoW.Export = Streamlined material assignment with a
- Objects that are themselves translucent will not perfectly match in-game translucency effects, because Blender does not have all of the blending modes available to do so (though a future release may provide some tooling for helping with this)
- "billboard" textures and sub-meshes (ones where the same side always "faces" the camera) are not currently supported.


### Future Plans

Things we are actively looking at doing in the near(ish) future:
Expand All @@ -36,10 +38,12 @@ Things we are actively looking at doing in the near(ish) future:
- Automatic texture upscaling with correct handling of alpha channels
- Other things that a human shouldn't have to do but currently have to (feel free to make suggestions)


## Installing

Install as any other addon, access via `File > Import > WoWbject`. You will also need Kruithne's wonderful [wow.export](https://github.com/Kruithne/wow.export) so that you'll be able to have something you can import. The WoWbject importer currently *requires* several features that are exclusive to wow.export, so don't try to use other export tools right now.


## Using

WoWbject Import is built to work with WoW.Export, and it reads both the JSON files that WoW.Export produces and the raw m2 files that it can export. You will need to install wow.export and have it configured in a specific way (in the wow.export settings page):
Expand All @@ -66,20 +70,24 @@ For assets that have UV animations, the add-on uses a driver inside of a node gr

The node automatically compensates for the frame rate of the scene that is active when the object is imported. It does this by referencing the scene's frame rate in the driver that the add-on sets up. As a result, if you import an object with UV animations into one file, and then append that object into another file, it will also append the scene that the driver references. You will almost certainly want to avoid this by removing the driver from the node before appending an object to another scene.


## Options and Preferences

The add-on preferences are relatively simple at the moment. Setting the Report Verbosity changes what kinds of reports the importer shows in the info editor, console, and status bar. It defaults to only showing warnings and errors. The updater settings control if and how frequently the add-on checks for updates, and are largely self-explanatory.


## Reporting Bugs (and Feature Requests)

We want the WoWbject Importer to be as accurate as possible when importing objects from WoW. If you run into situations where you think the importer is doing the wrong thing, *please* open an issue on the WoWbject Importer [issues page](https://github.com/ThatAsherGuy/WoWbjectImporter/issues) so that we can investigate!

We will also gladly accept feature requests via the same page. We can't guarantee we can implement everything requested, but we'll sure as heck give consideration to anything reasonable!


## License

As with all Blender addons, the WoWbject Importer is licensed under the GNU GPL. See the included [LICENSE](LICENESE) for specifics.


## Credits

This project was researched and beaten into existence through sheer force of will by [TDV Alinsa](https://github.com/alinsavix), who then conscripted [Asher Stephenson](https://github.com/ThatAsherGuy) to do much of the heavy lifting. I think we were both surprised how deep this particular rabbit hole went!
Expand All @@ -93,3 +101,17 @@ Many thanks to everyone who has contributed to the [WoWDev wiki](https://wowdev.
This add-on relies on an external python module called `kaitastruct`, which it uses to read additional data from .m2 files. The module is bundled with the add-on — you don't need to install or configure anything — but makes possible some of the things this importer does. Check out the [Kaitai Struct repo](https://github.com/kaitai-io/kaitai_struct_python_runtime). It's an awesome project. You can also find our work-in-progress on defining WoW data structures with kaitai-struct in Alinsa's [kaitai-warcraft](https://github.com/alinsavix/kaitai-warcraft) repo.

And finally, many kudos to the [Blender Foundation](https://www.blender.org/foundation/) and the numerous contributors to the Blender project, for providing such amazing software for us to build on. For all its flaws, it is still amazing that software of this size and breadth is available for free to anyone who cares to use it.


## Changelog

**v1.0.0:**

- Fixed: The importer can now handle meshes with duplicate faces
- Fixed: No longer explodes on OS X (file path handling)
- Changed: All reports are logged to the console, regardless of UI report settings
- Added: Can now set a default import directory

**v0.9.0:**

- First Release
2 changes: 1 addition & 1 deletion __init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"author" : "Asher and Alinsa",
"description" : "Import World of Warcraft objects as correctly as possible",
"blender" : (2, 90, 0),
"version" : (0, 9, 0),
"version" : (1, 0, 0),
"location" : "File > Import",
"wiki_url": "https://github.com/ThatAsherGuy/WoWbjectImporter",
"category" : "Import-Export"
Expand Down

0 comments on commit e36c5c4

Please sign in to comment.