Auto Mapping

AUTO mapping is a feature that enables the automatic detection of a file’s target path based on its ending. To activate AUTO mapping, use one of the AUTO... keywords in the "target" property of the mappings in the _map.py file. For more details on _map.py, refer to the The _map.py File section. The file endings recognized by AUTO mapping are defined in the auto_map.json file. For customization options, explore the Custom AUTO mapping section.

There are 4 AUTO... keywords available:

AUTO
AUTO_SUBFOLDER
AUTO_FLAT
AUTO_FLAT_SUBFOLDER

Additionally you can use:

SAME

Auto mapping keywords

AUTO

This mapping generates the target path based on the auto_map.json file and the source file’s path within the system folder.

Example:

[
    {
        "source": "some_path/my_behavior.behavior.json",
        "target": AUTO
    }
]

Assuming auto_map.json correctly maps .behavior.json to the BP/entities path, the evaluated target path will be BP/entities/some_path/my_behavior.behavior.json.

AUTO_SUBFOLDER

This keyword works similarly to AUTO but inserts the name of the system in the target path, in front of the source file’s path within the system folder.

Example:

[
    {
        "source": "some_path/my_behavior.behavior.json",
        "target": AUTO_SUBFOLDER
    }
]

The evaluated target path will be BP/entities/my_system/some_path/my_behavior.behavior.json.

AUTO_FLAT

The AUTO_FLAT keyword uses only the path defined in auto_map.json and the source file’s name, ignoring its path within the system folder.

Example:

[
    {
        "source": "some_path/my_behavior.behavior.json",
        "target": AUTO_FLAT
    }
]

The evaluated target path will be BP/entities/my_behavior.behavior.json.

This keyword is particularly useful for grouping files within the system using folders while keeping exported file paths short.

AUTO_FLAT_SUBFOLDER

AUTO_FLAT_SUBFOLDER combines AUTO_FLAT and AUTO_SUBFOLDER. It uses the auto_map.json path, name of the system, and the source file’s name.

Example:

[
    {
        "source": "some_path/my_behavior.behavior.json",
        "target": AUTO_FLAT_SUBFOLDER
    }
]

The evaluated target path will be BP/entities/my_system/my_behavior.behavior.json.

SAME

SAME is a special keyword that copies the path of the file in the system folder to the target path. It’s useful when you have a lot of custom files that don’t have a specific mapping and you want to copy their file structure to the target directory.

Example:

[
    {
        "source": "BP/entities/my_behavior.behavior.json",
        "target": SAME
    }
]

This mapping will copy the file to BP/entities/my_behavior.behavior.json.

The “name of the system”

The AUTO_SUBFOLDER and AUTO_FLAT_SUBFOLDER mappings use the “name of the system” in the target path. The name of the system is a path from the root of the group that contains the system to the system itself. If the system doesn’t belong to any group, the name of the system is the path from the root of the system template data folder to the system.

Overwriting the stem of the target

Sometimes, you may need more control over the target path, but you still want to use the benefits of automatically finding the target directory with AUTO mapping. System Template lets you use the AUTO mapping keywords in combination with the target->stem and target->dir properties to overwrite the stem of the target path while keeping the rest of the path generated automatically.

Note

The stem of a file path is the part of the path that comes after the last slash and before the file extension. System Template treats the file extensions differently than you might expect. In most software, the file extension is the part after the last dot in the file name. In System Template, the file extension is the part after the first dot in the file name.

For example, the following path aaa/bbb/ccc/ddd.eee.fff would be separated into the following parts:

aaa/bbb/ccc/ - dir
ddd - stem
.eee.fff - extension

As opposed to the more common division into aaa/bbb/ccc/, ddd.eee and .fff.

Using the custom stem for the target path is useful when you have a single file that serves as a template used to generate multiple files. Example:

_map.py

[
    {
        "source": "simple_block.feature.json",
        "json_template": True,
        "scope": {
            'identifier': f"nusiq:{block}",
            'block': f"minecraft:{block}"
        },
        "target": {
            "dir": AUTO_FLAT,
            "stem": block
        }
    }
    for block in ['diamond_block', 'stone', 'emerald_block']
]

Assuming that the simple_block.feature.json is a feature file that generates a feature with specified identifier, that places a specified block. This code will generate three feature files in the features directory.