• Stars
    star
    180
  • Rank 213,097 (Top 5 %)
  • Language
    Python
  • License
    GNU Lesser Genera...
  • Created over 8 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Blender exporter for the OGRE 3D engine

blender2ogre

This versions requires Blender 2.8+. For Blender 2.7x: use the 2.7x-support branch

Index

Installing

  1. Copy the io_ogre folder into the $BLENDER_DIR/scripts/addons folder.
  2. Enable the addon in Blender: Edit menu > Preferences > Add-ons. Search for 'ogre' and click the box up the top left.
  3. Configure the plugin before the first run.
    • Set the correct path to OGRETOOLS_XML_CONVERTER
      • for Ogre (v1): path should point to OgreXMLConverter.exe. This can be found in the Ogre SDK
      • for OgreNext (v2): path should point to OgreMeshTool.exe. This can be found in the OgreNext SDK
    • OPTIONAL Set MESH_PREVIEWER to a path pointed to ogre-meshviewer.bat. This can be found in OGRECave/ogre-meshviewer
    • Make sure that USER_MATERIALS isn't set to a directory like "C:\". The addon scans this path recursively and will crash when it hits a path it doesn't have permissions for.

NOTE: Installing Blender using Ubuntu Snap package or Fedora Flatpak will lead to the following error: cp: cannot create directory '/snap/blender/3132/3.4/scripts/addons/io_ogre': Read-only file system (see: Installing on Ubuntu 20.04 and Blender 3.4.1. #169)

There are two possible solutions:

  • After downloading the blender2ogre repo, uncompress it somwhere and then compress the io_ogre folder as a .zip file. Go to Edit -> Preferences (CTRL-ALT-U) -> Add-ons -> Install... and then select the file io_ogre.zip
  • Copy the io_ogre folder into the folder: ~/.config/blender/3.4/scripts/addons/ (where 3.4 is the Blender version)

Updating to new versions

If you are upgrading from a previous version of blender2ogre and having problems, you may want to delete your old .pickle config file from $BLENDER_DIR/config/scripts/blender2ogre.pickle and restart blender.

Video Tutorials

Exporting Meshes

To export a blender model: File Menu > Export > Ogre3D (.scene & .mesh).

If the menu button is greyed out (or you get this error: RuntimeError: Operator bpy.ops.ogre.export.poll() failed, context is incorrect), then make sure there is an active object selection in the blender Node tree (Scene collections) first. The active object selection is when there is an object with a yellow outline (in contrast to the orange outline of the passive selected objects)

  • If you have OGRETOOLS_XML_CONVERTER set to "OgreXMLConverter.exe" path, then the export dialogue will display options relevant to the Ogre (v1) mesh format.
  • If you have OGRETOOLS_XML_CONVERTER set to "OgreMeshTool.exe" path, then the export dialogue will display options relevant to the OgreNext (v2) mesh format.

Check out all the exporter and importer options in the Options Document

Materials

Materials will be exported as OGRE 1.x material files or as OGRE Next material.json files as required.

OGRE 1.x Materials

Materials are exported as RTSS OGRE 1.x materials (unless "Fixed Function Parameters" is selected). The following textures are exported: Base Color, Metallic and Roughness, Normal Map and Emission. Baked Ambient Occlusion is not supported for the moment.

Your material will be best exported if you follow the GLTF2 guidelines: glTF 2.0 - Exported Materials. Except for the Emission texture, where the Emission input of the Principled BSDF node is used as the Emission texture.

A good example of how the material should be setup for best results is the "Damaged Helmet" model found here: https://github.com/KhronosGroup/glTF-Sample-Models/tree/master/2.0/DamagedHelmet

OGRE Next JSON Materials

The current OGRE Next JSON exporter only explicitly supports a metalness workflow, however it will attempt to export materials not following that workflow regardless and may produce passable results.

For materials using metalness it expects a single image with the blue channel containing the metalness map and the green channel containing the roughness map fed into the Principled BSDF via a Separate RGB node. Not following this convention will print a warning to the console and the exported materials will likely not appear correctly when rendered.

There are numerous features in the Ogre Next JSON format that are not directly supported, see the Materials JSON notes for details.

Blender Modifiers Support

Blender has some very useful modifiers, and most of them are supported by blender2ogre but not all of them. Check out the Blender Modifiers Support Page to check out the list and also some recommendations about them.

Mesh triangulation issues

Cube with broken shading

If you are seeing some issues with the mesh triangulation (like visible triangles in your shading), check the Mesh Triangulation README to learn more about the subject and how to work around it.

OgreNext tips

If you do want to export in the OgreNext (v2.) format, make sure in the Export dialogue > General Settings > Mesh Export Version is set to V2. The following parameters are a good starting point to get a model exported to an Ogre mesh:

  • General
    • Mesh export version: v2
  • Materials
    • Export materials: ticked
  • Armature
    • Armature animation: ticked
  • Mesh
    • Export mesh: ticked
    • Edge lists: un-ticked
    • If your model's materials contain normal mapping:
      • Tangents: "generate with parity"
      • Else Tangents: "none"
    • Optimise Vertex buffers for shaders: ticked
    • Vertex buffer options: puqs

You can check the arguments passed to OgreMeshTool.exe in the Blender console. (Window Menu > Toggle System Console)

Blender will export the material format in an Ogre (V1) format. This is not compatible with OgreNext (V2.*). You should manually convert them to a material.json file. See the Ogre Wiki: HLMS Materials for more information.

Importing Meshes

As of blender2ogre version 0.8.2, the Kenshi Importer has been integrated into blender2ogre with the following features:

  • Import mesh from .xml as well as .mesh files
  • Option to be able to merge imported submeshes or keep them separate
  • Parsing/Conversion of materials into Blender (just create a Principled BSDF material and add a texture with the proper UV mapping)
  • Importing of Poses
  • Importing of Skeletons works for the most part, but Ogre skeletons conventions are not like Blenders (see: How to get bone's vector and bone's length?)
  • Importing of Animations work, but depends on the skeleton which sometimes doesn't get correctly imported

NOTE: Orientation of the imported mesh is assumed to be xz-y (Ogre default), the blender2ogre Axis Swapping option does not work for the importing process.

Additional Features

Merge Objects on export

You might have hundreds of objects, which you want to keep separate but have them in one .mesh on export. For this create a new collection (M) named merge.<yourname>. The output will be a single <yourname>.mesh file. Alternatively link the collection.

NOTE: The origin of the resulting merged object will be that of the last object you added to the collection (although when reloading the blend file, this order will be lost). To have control over the precise location of where the merged objects' origin will be, use the dupli_offset property of the collection. Setting any value other than the default (0, 0, 0) will result in a mesh with the origin set to that value. For example:

dupli-offset.png

Instancing and DotScene Plugin

As of OGRE 1.13 a new feature has been added to the DotScene Plugin where it now accepts the static / instanced keywords for entities. (for more information read the DotScene Plugin README).

To use this feature create a new collection (M) names as static.<Group Name> or instanced.<Instance Manager Name> and blender2ogre will automatically add the corresponding attribute to the exported entities in the Scene. This feature goes hand in hand with Exporting Particle Systems to create vegetation, debris and other static objects in your scene.

External OGRE Materials

You might already have some materials in OGRE that you do not want to export. Prefix them with extern.<yourname> and the sub-entity will have the material name set, but the material is not exported. The following material 'vertexcolor' can be defined in your OGRE project:

extern-material.png

Console Export

You might have several blender files in your project you want to export to Ogre. Do this by hand? NO! You can do better! Here is how you can export a scene with blender2ogre.

blender test.blend -b --python-expr "import bpy;bpy.ops.ogre.export(filepath='test.scene')"

Exporting Custom Vertex Groups

As shown in the picture below, you can now export SubEntities that contain a user-defined amount of faces.

blender-vertex-group.png

You simply call your vertex group with the prefix ogre.vertex.group.<yourname> and access it in Ogre similar to the following:

void example(const Ogre::Entity * entity)
{
    auto collision = entity->getSubEntity("collision");
    auto mesh = collision->getSubMesh();
    VertexData * data = nullptr;
    if (!mesh->useSharedVertices) {
        data = mesh->vertexData;
    } else {
        data = mesh->parent->sharedVertexData;
    }
    auto pos_cursor = data->vertexDeclaration->findElementBySemantic(Ogre::VES_POSITION);
    auto vbuffer = data->vertexBufferBinding->getBuffer(pos_cursor->getSource());
    auto ibuffer = mesh->indexData->indexBuffer;

    uint16_t * indices = static_cast<uint16_t*>(ibuffer->lock(Ogre::HardwareBuffer::HBL_READ_ONLY));
    float * vertices = static_cast<float*>(vbuffer->lock(Ogre::HardwareBuffer::HBL_READ_ONLY));
    float * v;
    int count = mesh->indexData->indexCount;
    int stride = vbuffer->getVertexSize() / 4;
    for (int i = 0; i < count; i+=3) {
        uint16_t a = indices[i], b = indices[i+1], c = indices[i+2];
        pos_cursor->baseVertexPointerToElement(vertices + a * stride, &v);
        Vector3 va(v);
        pos_cursor->baseVertexPointerToElement(vertices + b * stride, &v);
        Vector3 vb(v);
        pos_cursor->baseVertexPointerToElement(vertices + c * stride, &v);
        Vector3 vc(v);
        // do something with your triangle here
    }
    ibuffer->unlock();
    vbuffer->unlock();
}

The vertex group will get the material name 'none' so you might want to add the following script:

material none {
    technique {
        pass {
           // ...
        }
    }
}

Exporting Custom Normals

Cube with Filled Edges

Custom Split Normals is a way to tweak the mesh shading by pointing normals towards directions other than the default, auto-computed ones. It is mostly used in game development, where it helps counterbalance some issues generated by low-poly objects (the most common examples are low-poly trees, bushes, grass, etc. and the โ€˜roundedโ€™ corners). Check out the Custom Normals README to learn more about Custom Normals in Blender.

Exporting Skeletal Animations

skeletal-animations.png

Skeletal Animation refers to the technique of using bones to deform a mesh as if the mesh were the skin. This kind of animation is commonly used to animate characters in video games. Check out the Skeletal Animations README to see how to create and export an animated mesh.

Exporting Particle Systems

particle-system5.png

A common technique for laying out random objects on a scene in Blender is to use the Particle System. Check out the Particle System README to see how to create and export a scene where the trees, foliage and rocks are distributed randomly using a particle system.

Exporting Shape Animations

shape-animations4.png

Shape (or Pose) Animations allow animating different poses, a technique commonly used to do face animations. Check out the Shape Animations tutorial to see how to create some poses and animate them. Then you can use blender2ogre to export the poses and animations into a .mesh file.

Exporting Node Animations

Node Animations are a way to have scripted node animations in your Ogre application. Check out the Node Animations tutorial to see how to create some animations for a couple of different scenarios.

Exporting for Physics

Check out the Exporting for Physics tutorial to see some techniques and optimizations when exporting collision meshes for Physics Engines

Mesh Previewer

If MESH_PREVIEWER is set, a button will appear allowing you to preview your mesh in Ogre3D. If the button isn't there, the path is invalid. This only works for Ogre (V1) meshes. The button is located here:

Preview mesh button location

About

The original version of this was a single monolithic Python file. This is not maintainable and contains a tremendous amount of bugs. There was the need to export Blender model to OGRE from the console, thus I rewrote the whole script and split it into several files. It has been well-tested on Linux 64-bit and should work with others.

Authors

This Blender addon was made possible by the following list of people. Anyone can contribute to the project by sending bug reports and feature requests here. Naturally, the most welcome contribution is actual code via pull requests. If you are planning to implement something "big", it's a good practice to discuss it in the issue tracker first with other authors. So that there is no overlap with other developers or the overall roadmap.

Additionally, the following companies have supported/sponsored the development efforts.

More Repositories

1

ogre

scene-oriented, flexible 3D engine (C++, Python, C#, Java)
C++
3,929
star
2

ogre-next

aka ogre v2 - scene-oriented, flexible 3D C++ engine
C++
1,032
star
3

ogitor

Ogitor SceneBuilder, the WYSIWYG scene editing environment for OGRE
C++
88
star
4

scape

Scape terrain editor
C++
50
star
5

ogre-meshviewer

Viewer for .mesh and .scene files as consumed by OGRE as well as any format supported by assimp
Python
47
star
6

ogre-procedural

procedural geometry for Ogre3D
C++
40
star
7

ogre-imgui

Now in the main repository as part of Overlay
C++
32
star
8

ogre-next-deps

Packaged ogre-next dependencies' sources with a convenient CMake build system.
C
29
star
9

particleuniverse

feature-rich ParticleFX alternative
C++
27
star
10

ogre-assimp

Now in the main repository as Plugin
C++
27
star
11

ogre-pagedgeometry

Paged Geometry is a component for rendering of dense vegetation
C++
19
star
12

EasyOgreExporter

3DS max exporter for the OGRE 3D engine - mirror
C++
18
star
13

ogre-caelum

Library for rendering of dynamic and realistic skies
C++
17
star
14

ogre-audiovideo

plugins for theora video playback and openAL audio
C++
13
star
15

btogre

Now in the main repository as Component
C++
13
star
16

x3ogre

connecting X3D to a state of the art rendering engine
C++
11
star
17

language-ogre-script

Syntax highlighting for Ogre Scripts in Atom/ VSCode
JavaScript
10
star
18

ogre-gpgpu

GPGPU compute with Ogre using CUDA or OpenCL
C++
9
star
19

ogre-planet

dynamic level of detail for planetary rendering
C++
9
star
20

meshmagick

a versatile command line Ogre mesh manipulation tool
C++
7
star
21

OgreCrowd

Pathfinding for Ogre using Recast/Detour
C++
6
star
22

DotSceneFormat

Now in the main repository
C++
6
star
23

ogre-oggsound

now at:
C++
5
star
24

shiny

a shader and material management library for OGRE
C++
4
star
25

evolution

proposals for changes and enhancements to OGRE
4
star
26

ogrewater

OgreWater is a water module for Ogre3D that is simple to use!
C++
2
star
27

ogre-attic

For historical needs only. All exported CVS history with metadata.
C++
1
star