Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ithamar committed Jul 20, 2022
1 parent 424c914 commit 494c149
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
# Carnivores Export Addon for Blender

This is a first stab at creating an addon to support modelling/rigging/animating classic Carnivores models in Blender.
This addon is supports exporting Blender models and animations into 3DF / VTL files.

NOTE: This addon has only been tested with Blender 2.92.0
3DF export simply exports the basic geometry (vertices,faces,active uvlayer) into the 3DF format. Material export is currently not supported.
VTL export basically plays the active scene animation, and captures the vertices of the mesh for every frame in the animation, and writes that to VTL.

These features allow you to do all your modelling/rigging/animating from Blender instead of using the 20+ year old tools that were released with Carnivores.

To create CAR files out of the 3DF and VTL files, you'll have to use either [CMM](https://game3dee.com/cmm/) or [c3dit](https://github.com/carnivores-cpe/c3dit).

## Install

Simply go to Edit/Preferences/Addons, click Install, and select `io_carnivores.py`. You should see the addon in the addon list, click the checkbox before its name to enable, and you should be good to go.
Simply go to Edit/Preferences/Addons, click Install, and select `io_carnivores.py`. You should see the addon in the addon list, click the checkbox in front of its name to enable, and you should be good to go.

## Exporting 3DF

Simply open any Blender file, select the mesh you wish to export as 3DF model, and select File/Export/3DF. Specify name/location of output file, and you should have a 3DF file usable in CMM / C3dit, etc.
In any Blender document, select the mesh you wish to export as 3DF model, and select File/Export/3DF. Specify the file to be written and any configuration options.

## Exporting VLT

In any Blender project, select an active animation, then select the mesh, go to File/Export/VTL, choose name/location of output file, and you should be good to go.
In any Blender document, make sure you have the animation you wish to export active in the scene, then select the mesh (or armature), go to File/Export/VTL. Specify the file to be written and any configuration options.

## Troubleshooting / bugs

This is my first Blender addon, so please be gentle. Known issues:

* Due to the VTL format, very small objects will show artifacts due to limited X/Y/Z value range.
* Using a model without uv layer gives script errors
* Selecting something else then a mesh will cause script errors
* Due to the way VTL stores vertices (as signed 16-bit integers, by doing `float * 16`) very small objects or very large ones will
* Likely much more ;)

Feel free to let me know any additional issues you run into, or any features you would like to see added.

0 comments on commit 494c149

Please sign in to comment.