View source for HPL3/Blender HPL3 export plugin

{{shortPageTitle}}
__NOTOC__
[[Category:Modding]]
[[Category:English]]
This addon allows you to model anything from single assets to entire maps within Blender, and synchronize them to an HPL3 engine map, automatically creating and configuring textures, material, and entity files for a fast iteration process. The script is also capable of removing objects from the HPL3 map which have been removed in the Blender scene, exporting rigged and animated objects, and baking lighting onto scene objects.

Add-on homepage: [https://github.com/cadehaley/BlenderHPL3export GitHub]

== Installation ==

The add-on requires Blender 2.80 or later.

# Go to [https://github.com/cadehaley/BlenderHPL3export GitHub] → "Clone or Download" → "Download ZIP"
# Copy <code>io_export_hpl3.py</code> and the <code>/nvidia</code> folder to Blender's addons directory (<code>".../Blender/2.80/scripts/addons"</code>)
# Open Blender, go to Edit → Preferences → Add-ons → Search "hpl3"
# Check box next to '''Import-Export: HPL3 Export''' and press '''Save Preferences'''
# Exit window and go to the Tools bar in the left side of the 3D View. Drag the width of the Tools bar out to set fields, and press '''T''' to hide the tools bar at any time. Have fun!

== Important usage notes ==

On export, the sub directory and mesh file will take this name <code>Suzanne.dae</code>, and having name conflicts in HPL3 can cause the wrong textures to load. The <code>Object Name</code> does not matter as much, and will be used to name that instance of the object when placed in the map.

Give each object a unique name in the asset's <code>Object Data</code> panel (under the poly triangle icon, not to be confused with the <code>Object</code> panel under the cube icon). Example:
<pre>
Object name = "evil_suzanne_by_doorway.005"
Mesh Datablock name = "Suzanne"
</pre>

* '''Rigged Meshes''': Use <code>Single Export</code> when you have an animated mesh broken into separate objects (e.g. shirt, head, hair) that are deformed by the same armature (skeleton). Exporting meshes that are deformed by different armatures to one file/entity is not supported by HPL3 and will produce unexpected results.
* '''Baking Modes''': Textures Per Material: Think of each material as having its own UV set. Faces assigned to Material A cannot overlap in the UV editor with other Material A faces, though it is ok (even recommended) for faces assigned to Material B to use up the full UV space, since it won't matter if a face from Material A overlaps with a face from Material B.
* '''Textures Per Material:'''  Think of each material as having its own UV set. Faces assigned to Material A  cannot overlap in the UV editor with other Material A faces, though it is ok  (even recommended) for faces assigned to Material B to use up the full UV space,  since it won't matter if a face from Material A overlaps with a face from Material B.
* '''Instancing''': Use <code>Alt+D</code> to create copies of an object in Blender to place around a map, since they will point to the same <code>Mesh</code> datablock. Using Copy/Paste or Shift+D creates a new <code>Mesh</code> datablock every time, and therefore a new .dae and .dds file on export, leaving you with multiple repeat numbered .dae and/or .dds files taking unnecessary space on export.
* If texture is black or has black parts, make sure UV faces are within the square UV boundary. Texture baking requires that each material use a single <code>Principled BSDF</code> node and that all UV faces lie within UV coordinate bounds

== Troubleshooting ==

* Hover your pointer over options for more in-depth info on how to use them
* When using <code>Textures Per Material</code>, if texture is black or has black parts, make sure objects are UV unwrapped and UV faces are within the UV boundary. This mode requires that all UV faces lie within UV image bounds.
* If materials are failing to export properly, try switching between <code>Textures Per Material</code> and <code>Textures Per Object</code>, as one mode may work better with your material setup than the other. Also, keep in mind that texture baking requires that each material use a single <code>Principled BSDF</code> node
* In the Level Editor, if objects fail to appear after pressing the button to reload static object or entity changes, try exiting out of the editor and reloading your map to make objects appear properly again.

== Bugs ==

For any questions or to report any bugs, message me @cadely on the [https://discordapp.com/invite/frictionalgames|Frictional Games Discord] or on [http://frictionalgames.com/forum frictionalgames.com/forum]

== Further reading ==

* [[Blender | Working with Blender for HPL]]