Blender_bevy_components_wor.../tools/gltf_auto_export
Mark Moissette 32d01eb48f
refactor(examples): restructure examples (#44)
* refactor(examples): moved examples into more logic folders & changed to allow for per example dependencies
* chore(): updated docs, added docs, updated deps , cargo files etc
2023-11-13 14:36:42 +01:00
..
README.md refactor(examples): restructure examples (#44) 2023-11-13 14:36:42 +01:00
__init__.py feat(): Blueprints, crates, enhanced Blender tooling & more (#5) 2023-09-28 14:10:45 +02:00
gltf_auto_export.py chore(tools/gltf_auto_export): bump version number after recent bugfixes (#42) 2023-11-11 21:41:15 +01:00

README.md

gltf_auto_export

This Blender addon

  • automatically exports your level/world from Blender to gltf whenever you save your Blend file.
  • in Blueprints mode (highly recommended !) :
    • supports automatic exports of used collections as Gltf blueprints
    • supports any number of main/level scenes
      • Blender scenes where you define your levels, and all collection instances are replaced with "pointers" to other gltf files (all automatic)
    • supports any number of library scenes
      • Blender scenes where you define the assets that you use in your levels, in the form of collections
    • automatic export of changed objects & collections only ! a sort of "incremental export", where only the changed collections (if in use) get exported when you save your blend file

Installation:

  • in Blender go to edit => preferences => install

blender addon install

  • choose the path where gltf_auto_export/gltf_auto_export.py is stored

blender addon install

Usage:

Basics

  • before it can automatically save to gltf, you need to configure it
  • go to file => export => gltf auto export

blender addon use

  • set the autoexport parameters in the auto export panel:

    blender addon use3

    • export folder

    • pick your main (level) scenes and library scenes (see the chapter about Blueprints below)

      • click in the scene picker & select your scene

      select scene

      • click on the "+" icon

      select scene2

      • your scene is added to the list

      select scene3

  • and your standard gltf export parameters in the gltf panel

blender addon use2

  • click on "apply settings"
  • now next time you save your blend file you will get an automatically exported gltf file (or more than one, depending on your settings, see below)

Blueprints

You can enable this option to automatically replace all the collection instances inside your main scene with blueprints

  • whenever you change your main scene (or your library scene , if that option is enabled), all your collection instances

    • will be replaced with empties (this will not be visible to you)
    • those empties will have additional custom properties / components : BlueprintName & SpawnHere
    • your main scene/ level will be exported to a much more trimmed down gltf file (see next point)
    • all the original collections (that you used to create the instances) will be exported as seperate gltf files into the "library" folder
  • this means you will have

    • one small main gltf file (your level/world)
    • as many gltf files as you have used collections in the main scene , in the library path you specified : for the included advanced example's assets, it looks something like this:

    library

    the .blend file that they are generated from can be found here

  • the above only applies to collections that have instances in your main scene! if you want a specific collection in your library to always get exported regardless of its use, you need to add a COLLECTION (boolean) custom property called AutoExport set to true

    not at the object level ! the collection level !

    force-export

    It will get automatically exported like any of the "in-use" collections.

  • you can also get an overview of all the exported collections in the export menu

    exported collections

Process

This is the internal logic of the export process with blueprints

process

ie this is an example scene...

and what actually gets exported for the main scene/world/level

all collections instances replaced with empties, and all those collections exported to gltf files as seen above

License

This tool, all its code, contents & assets is Dual-licensed under either of