Skip to content

BenchmarkSims/bms-blender-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Falcon BMS Blender Plugin

Banner

Official Falcon BMS BMLv2 plugin for Blender


Supported Versions

Currently, the plugin supports Blender 3.6 LTS. Support for 4.x is in development. The plugin requires Falcon BMS 4.37.4 or a later version. The plugin including the DDS export & import was tested to work in Windows and Linux. Mac should work but is currently untested.


Quickstart

Installation / Updating

  • Download the plugin from the releases page.
  • In Blender: install the plugin (Edit → Preferences → Add-ons → Install..) and enable it.
  • Recommended: configure the path to the BMS Editor in the plugin preferences.

⚠️ You MUST completely restart Blender after each plugin update.

Falcon BMS Panel

Access the plugin panel from the Blender toolbar.

Toolbar

BMS Specific Items

  • DOFs - used for animations, can rotate/translate/scale their children.
  • Switches - show/hide parts of the model.
  • BBL Lights - billboard lights without light emission, usually used for stationary lights (e.g. airport installations).
  • Hotspots - make parts of the model clickable, used for cockpits.
  • Slots - slots which will allow adding dynamic parts to your model (bombs, missiles, ...).
  • Bounding Box - a bounding box of your model.

Exporting

  • Use File → Export → F4-BMS (.bml)
  • Make sure to export both the model and the Materials.mtl (or the BMS Editor will not load your model).

Further Resources


Contact, Reporting Issues

For general questions or feature requests, you can contact the BMS team on Discord or the Forum.

If you want to report an issue, please use this projects issue tracker and provide the following details:

  • The versions of the plugin (displayed in the Blender preferences), your Blender version and the Falcon BMS version.
  • The full Blender text output (see how to launch Blender from the command line).
  • A .blend file which helps us with reproducing an issue (minimal examples are preferred to full models).
  • Exact steps which lead to the issue (written, a video, ...).
  • If your model crashes the Editor.exe: the relevant _xlog.txt, _crash.txt and _crash.dmp from your <Your Falcon BMS Directory>/User/Logs.

Plugin Data

The Plugin uses a number of XML files for IDs (vic. "numbers") which is read by the BMS engine. Since the files are shared with the 3D Studio Max Exporter, their format should be kept compatible. All files are located in the folder bms_blender_plugin/common.

File name Purpose
callbacks.xml List of BMS Callbacks for cockpit Hotspots
DOF.xml List of BMS DOF names and their unique DOF numbers
script.xml List of BMS Script names and their numbers
switch.xml List of BMS Switches and their numbers

These files are currently maintained in collaboration with the BMS code team. Any incorrect, outdated or missing items should be brought forward to public channels so that fixes can be incorporated to all platforms. A small tool to demonstrate a way to sync the callbacks.xml is located in util/callbacks.py.


Development


License

This project is published under the MIT License. For DDS export and import, this plugin uses parts of the Blender DDS Addon.