Skip to content

Scenery & Aircraft export addon for Blender and X-Plane

License

Notifications You must be signed in to change notification settings

X-Plane/XPlane2Blender

Repository files navigation

Build Status Code style: black Imports: isort

Introduction

This addon for Blender 2.80 and up makes it possible to export models made in Blender to the X-Plane object format (.obj). An experimental importer has been added in 4.2.0-Alpha 1 and can be found here: https://github.com/X-Plane/XPlane2Blender/releases/tag/v4.2.0-alpha.1

Contact Us

The best way to contact us is through a bug report. Otherwise, e-mail ted at x-plane dot com, especially if you're worried about the security of your models while we debug them.

General Requirements

  • Blender 2.80-83. 2.90 seems to work but is not officially supported
  • For the greatest stability, use the latest non-beta version of XPlane2Blender

XPlane2Blender for Blender 2.79 can still be downloaded from the releases page, but it isn't supported anymore. An experimental converter for Blender 2.49 projects is also available and is supported.

Automatic Installation

Note: This process will override an existing copy of the plugin! To backup your current version of the plugin, see the manual instructions in the manual. Always make backups of your work, especially when beta testing, as newer versions may not be backwards compatibility. Read the release notes for more details.

  1. Download the addon with a name like io_xplane2blender_4_0_0-rc_1-89_20200910152046.zip. Do not download the .zip file called "Source Code", do not unzip the io_xplane2blender .zip file
  2. In Blender, open up the Preferences, go to the Addons tab, and click at the bottom "Install From File..."
  3. Using the file picker, find the .zip file and click "Install From File...". This will automatically unzip to the addons folder
  4. Ensure the checkbox next to the words "Import-Export: Export: X-Plane (.obj)" is checked
  5. Restart Blender even if you see the UI change
  6. Begin using XPlane2Blender!

For less stable betas or different versions see the releases page. Be sure to read the notes.

Get Started!

See the Introduction to XPlane2Blender Video and download the example files and you'll be well on your way to exporting your first mesh and seeing it in X-Plane! Although the Blender version shown is Blender 2.79, XPlane2Blender is almost entirely the same across versions.

Documentation Sources

Test Suite

The average user does not need the test suite. Before releasing a build to the public we test the code many many many times! This is only useful for developers and power users who make changes to the source code. The tests folder must also be in the same folder as the addon folder (see manual installation).

If you have Python installed (hopefully matching Blender's internal interpreter for maximum stability) and the full source code downloaded, you can run the test suite. It will attempt to export sample .blend files that utilize various features of the exporter and print the results (see the contents of the test folder). All passing means XPlane2Blender is safe to use. In the XPlane2Blender folder, open up a command line and run

python tests.py --print-fails

This will run all tests until the end or a failure occurs. Only detailed logs will be printed for the failed test. See --help to show all flags and what they do.