Skip to content
🐡 Embark Addon for Blender
Python
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Use the repository name as the module to lint Dec 6, 2019
.vscode VSCode: Trim trailing whitespace and EOF newlines Dec 16, 2019
exporter Use origin's full transform when offsetting export Dec 15, 2019
icons
images Initial commit of blender-tools repo Dec 4, 2019
operators Removed full stops from the end of docstrings Dec 15, 2019
utils Initial commit of blender-tools repo Dec 4, 2019
.editorconfig Initial commit of blender-tools repo Dec 4, 2019
.gitignore Initial commit of blender-tools repo Dec 4, 2019
.mergify.yml Initial commit of blender-tools repo Dec 4, 2019
.pylintrc Initial commit of blender-tools repo Dec 4, 2019
CODE_OF_CONDUCT.md Initial commit of blender-tools repo Dec 4, 2019
CONTRIBUTING.md Initial commit of blender-tools repo Dec 4, 2019
LICENSE-APACHE Initial commit of blender-tools repo Dec 4, 2019
LICENSE-MIT Initial commit of blender-tools repo Dec 4, 2019
README.md Link to latest release Dec 6, 2019
__init__.py Bumped version number to 1.6.0 Dec 15, 2019

README.md

🐡 Embark Blender Tools

Build Status Contributor Covenant Embark

A Blender add-on containing workflow tools for game development, created and maintained by Embark Studios.

The add-on includes tools for standardized import/export workflow, 3D modelling and new object types.

We welcome Pull Requests - if you would like to contribute, please check out the Contributing section.

Prerequisites

Installation

  1. Download the latest release of the addon from Github!

  2. Launch Blender and navigate to Edit -> Preferences, then choose the Add-ons section:

    Screenshot of Preferences menu
  3. Click Install in the top right of the Preferences window

  4. Use the file browser to navigate to the file you downloaded, then click Install Add-on:

    Screenshot of file browser with Install Add-on option
  5. Find the Embark Addon in the add-ons list, and ensure that the checkbox is checked:

    Screenshot showing Embark Addon with active checkbox

Updating the add-on

The tools contain built-in update functionality, so you should only need to run through this process once!

If you don't want the add-on to auto-update, please disable the Automatically check for updates checkbox in the Preferences section of the Embark Addon.

Tools

Below is a concise list of some of the functionality offered by the Embark Blender Tools.

Export Collections

Export Collections are used to define lists of objects that will be exported to a single model file. The tools all use FBX for exports to game engines like Unreal, and OBJ for highpoly objects for baking.

Working with Export Collections

There are a few things to keep in mind when working with the Embark Export Collection tools:

  1. You must configure your Project source folder in the Embark Addon's Preferences panel, as shown below.

    Screenshot showing Embark Addon Preferences

    This sets the absolute root for exporting, and all export paths will be stored as paths relative to this.

  2. All Blender scenes must be saved relative to the Project source folder

  3. Export Collections will fail to export if your scene is not saved, or is saved under a path outside of the Project source folder!

Creating a new Export Collection

You can create a new Export Collection from selected objects as shown here:

  1. Select one or more objects that you would like to export

  2. Click on the Embark tab to the right of the 3D View

  3. Click on Create New Export Collection

    Screenshot showing how to create an Export Collection from selected objects
  4. In the File Browser that pops up, select the location and name for your new export.

    • On the right, you will see some settings:

      Screenshot showing Export Collection settings
    • Select the preset that is appropriate for your asset type - this will enforce some naming conventions

    • If you disable Export Immediately, the Export Collection will be created, but not exported

You will now see a new Collection in the outliner, named to match the export file name you chose.

Modifying an existing Export Collection

Export Collections are stored in the Blender scene, and can be modified and exported at any time.

All Export Collections are shown in the Embark panel, and Export Collections that contain the selected object will be auto-expanded.

You can use the fields on each Export Collection to modify:

  • Output file name
  • Export type
  • Output folder (relative to your Embark Addon's configured Project source folder)

Screenshot showing Export Collection buttons in the Embark panel

Each Export Collection shown in the panel also has convenience functionality on the icon buttons shown above:

  • Select objects contained in this Export Collection
  • Add selected objects to this Export Collection
  • Remove selected objects from this Export Collection
  • Export this Export Collection
  • Delete this Export Collection from the scene
    • Note that the objects it contained will remain in the scene!

Exporting objects and Export Collections

You can always press the Export All button from the Embark panel, and you can also use the Embark -> Export All Collections menu item if you aren't in a context that shows the panel. This will export every Export Collection in the current scene.

If you are working on a particular object, you can use the Export by Selection button from the Embark panel. This is also accessible via the Embark -> Export Collection(s) by Selection menu item. This will export only those Export Collections that contain any of the currently selected objects.

These commands can all be bound to hotkeys or added to the Quick menu by right-clicking on them from the Embark menu.

Import

Accessed from the Embark -> Import menu item.

Imports objects (FBX, OBJ, PLY) using hard-coded standard settings to enforce consistency.

Spiral Curve

Accessed from the Embark -> Spiral menu item, or the 3D viewport's Add -> Curve -> Spiral menu item.

Adds a parametric spiral curve object to the scene.

Connect Contextual

Mesh editing, connects verts/edges/faces depending on selection.

Frame Contextual

Accessed from the 3D viewport's View -> Frame Contextual menu item.

Frames the selection in the 3D viewport, or frames the whole scene if nothing is selected.

Contributing

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

You can’t perform that action at this time.