Envoy User Manual

The STL manager you didn’t know you were missing.

Got questions? Check the FAQ, email us on [email protected] or join us in our Discord - look for Piete and Steve :)

Last updated: 20210826 for Envoy 0.10.7

Installation and setup

Download and install Envoy from the download page.

After installation, run Envoy and configure the library path. Click “Rescan library” to run the scanner, models should appear as the results!

Rescanning the library

Go to Settings and push rescan. The database will be emptied before being repopulated.

Customising tags and adding notes

You can add custom tags by going to Files and clicking on a folder to add tags to.

Notes are available from the Model Details page (click on the image or the title on the Models page).

Understanding the definition of “a model”

Envoy really cares most about the concept of a “model”. A model can be:

  1. Single: Single file to produce a single result (eg a monopose hero character)
  2. Multipart: Multiple files, which combine to produce a result (eg a vehicle split in multiple parts or multipart figures with 4 heads, 3 torsos, 2 legs)
  3. Model group: Multiple files, which are related but produce individual results (eg a collection of differently sized cobblestone bases)

A model is created during during scanning (see below for details on the scanner behaviour), from any folder that contains at least one file that Envoy recognises (STL, lychee, jpg, etc). Envoy doesn’t see between folder boundaries, so nested directories with Envoy-recognised-files are treated as new models.

Scanner behaviour

The scanner creates “models” from the collections of files in the library path, by reading each directory and file in the tree.

A tag for each folder in the heirarchy is automatically created for the model. For absolutely best results, we recommend organising your files by model:

/library_folder
    - /collection_name
        - /sub_collection
            - /modelname
                - body.stl
                - head.stl
                - body_supported.stl
                - head_supported.stl
                - body.chitubox
                - head.chitubox
                - body.lys
                - head.lys
                - model.jpg
                - model.png

By default, without the tag manager, this will generate a single model with the following tags:

collection_name
sub_collection
modelname

Modifying the tags

This can be modified by including and excluding tags. When the scanner processes the tree, it handles tags in the following order, for each folder:

  • Add automatic tags
  • Remove anything excluded from this folder or above
  • Add anything included from this folder or above

The result can be seen under the filename in the header panel marked “Tag result”.

Example: nested includes

If collection_name included the tag “Scenery”, and modelname includes the tag “Trees”, modelname will have the following tags:

collection_name
sub_collection
modelname
Scenery
Trees

The first three from the automatic tag generation, the next two from the manual includes.

Example: includes and excludes

If collection_name included the tag “Scenery”, and modelname excludes the tag “collection_name”, modelname will have the following tags:

sub_collection
modelname
Scenery

The first two from the automatic tag generation, “Scenery” from the include in collection_name, then the tag “collection_name” is removed from the exclude in modelname.

Excludes can remove autogenerated tags as well as your own custom tags.

User interface icons

STL files, probably without supports

STL configuration files (Chitubox or Lychee)

STL files, probably with supports

Number of tags

Open in file browser