04. Customising MiEx and Pipeline Integration

Most settings on how MiEx works is specified via resource packs, but there are a couple of settings that are global in MiEx and not specified in resource packs. These settings are instead specified via environment variables or command-line arguments.

MiEx was written from the start for use in animations, and so these environment variables and command-line arguments can be used to help integrate MiEx into your CG pipeline.

Environment variables

Name	Default Value	Description
MIEX_HOME_DIR	./	The folder in which to start the export file dialog.
MIEX_RESOURCEPACK_DIR	./resources	The folder in which all of the resource packs that MiEx can use are located.
MIEX_RESOURCEPACK_USD_PREFIX	Absolute path of ./resources/	The prefix given to the texture paths specified in USD. It's meant to be the USD equivalent of MIEX_RESOURCEPACK_DIR. If it doesn't end with a forward slash, then MiEx will add one.
MIEX_RESOURCEPACK_JSON_PREFIX	Absolute path of ./resources/	The prefix given to the texture paths specified in JSON files. If it doesn't end with a forward slash, then MiEx will add one.
MIEX_USDCAT_EXE	./usdcat/usdcat.exe	The path of the usdcat command-line tool, used by MiEx to be able to export out into USD Crate files rather than USD ASCII files.
MIEX_LOG_FILE	./log.txt	The path to where it should write out all console outputs and errors.
MIEX_MINECRAFT_ROOT_DIR	Default Minecraft install directory	The path to the Minecraft launcher root directory. This allows MiEx to find Minecraft versions and saves from the Minecraft launcher if it is installed somewhere other than the default location.
MIEX_MULTIMC_ROOT_DIR	null	The root directory of a MultiMC (or fork of MultiMC like Prism) install.
MIEX_TECHNIC_ROOT_DIR	%APPDATA%/.technic/	The root directory of a Technic install.
MIEX_MODRINTH_ROOT_DIR	%APPDATA%/ModrinthApp/	The root directory of a Modrinth install.
MIEX_HYTALE_ROOT_DIR	%APPDATA%/Hytale/	The path to the Hytale launcher root directory. This allows MiEx to find versions and saves from the Hytale launcher.
MIEX_ADDITIONAL_SAVE_DIRS	null	A list of save folders to show in the world browser. Each save folder is the path to it and the list is separated with a semicolon ;.
MIEX_NUM_UI_THREADS	4	The number of threads that MiEx should leave alone, so that it won't stall your entire computer.
MIEX_PORTABLE_EXPORTS	0	Whether MiEx should make exports with all files used inside of the export's chunks folder, making the export fully portable. By default MiEx puts in the paths to the files directly in the resource pack folders, which prevents lots of unnecessary duplicate files, but makes it difficult to share exports.
MIEX_GITHUB_REPO	BramStoutProductions/MiEx	The GitHub repository that MiEx should check for the latest versions of the built-in files. You can change this if, for example, you're working in a team and want to have your own set of built-in files.
MIEX_OFFLINE_MODE	0	Puts MiEx into offline mode where it won't check GitHub for new versions of MiEx or new built-in files.
MIEX_STORE_GEN_TEX_IN_EXPORT	0	If true, textures generated by MiEx (banners, player skins) are stored in the chunks folder of the export. If false, they are stored in a resource pack.
MIEX_GEN_TEX_RP_NAME	base_resource_pack	The resource pack name to put textures generated by MiEx into. By default they are put into the base_resource_pack.

Command-line arguments

Name	Default Value	Description
-homeDir <path>	%MIEX_HOME_DIR%	The folder in which to start the export file dialog.
-rpDir <path>	%MIEX_RESOURCEPACK_DIR%	The folder in which all of the resource packs that MiEx can use are located.
-rpUSDPrefix <string>	%MIEX_RESOURCEPACK_USD_PREFIX%	The prefix given to the texture paths specified in USD. It's meant to be the USD equivalent of MIEX_RESOURCEPACK_DIR
-rpJSONPrefix <string>	%MIEX_RESOURCEPACK_JSON_PREFIX%	The prefix given to the texture paths specified in JSON files. It's meant to be the JSON equivalent of MIEX_RESOURCEPACK_DIR
-usdcatExe <path>	%MIEX_USDCAT_EXE%	The path of the usdcat command-line tool, used by MiEx to be able to export out into USD Crate files rather than USD ASCII files.
-multimcRootDir <path>	%MIEX_MINECRAFT_ROOT_DIR%	The path to the Minecraft launcher root directory. This allows MiEx to find Minecraft versions and saves from the Minecraft launcher if it is installed somewhere other than the default location.
-multimcRootDir <path>	%MIEX_MULTIMC_ROOT_DIR%	The root directory of a MultiMC (or fork of MultiMC like Prism) install.
-technicRootDir <path>	%MIEX_TECHNIC_ROOT_DIR%	The root directory of a Technic install.
-modrinthRootDir <path>	%MIEX_MODRINTH_ROOT_DIR%	The root directory of a Modrinth
-hytaleRootDir <path>	%MIEX_HYTALE_ROOT_DIR%	The root directory of a Hytale install.
-additionalSaveDirs <paths>	%MIEX_ADDITIONAL_SAVE_DIRS%	A list of save folders to show in the world browser. Each save folder is the path to it and the list is separated with a semicolon ;. This is an alternative to %MIEX_ADDITIONAL_SAVE_DIRS%.
-numUIThreads <number>	%MIEX_NUM_UI_THREADS%	The number of threads that MiEx should leave alone, so that it won't stall your entire computer.
-usdcatExe <path>	%MIEX_USDCAT_EXE%	The path to the usdcat executable. If it exists, it will use this to convert the USD files to USDC (binary) files. USDC files are more efficient.
-log <path>	%MIEX_LOG_FILE%	The path to where it should write out all console outputs and errors.
-resourcePack <string>		The name of a resource pack in %MIEX_RESOURCEPACK_DIR% that should be loaded by default. This argument can be specified multiple times to have multiple resource packs loaded by default. The first resource pack specified will then be the highest priority.
-portableExports		Whether MiEx should make exports with all files used inside of the export's chunks folder, making the export fully portable. By default MiEx puts in the paths to the files directly in the resource pack folders, which prevents lots of unnecessary duplicate files, but makes it difficult to share exports.
-offlineMode		Puts MiEx into offline mode where it won't check GitHub for new versions of MiEx or new built-in files.
-githubRepo <string>	BramStoutProductions/MiEx	The GitHub repository that MiEx should check for the latest versions of the built-in files. You can change this if, for example, you're working in a team and want to have your own set of built-in files.
-storeGenTexInExport		If specified, textures generated by MiEx (banners, player skins) are stored in the chunks folder of the export. If false, they are stored in a resource pack.
-genTexRpName <string>	base_resource_pack	The resource pack name to put textures generated by MiEx into. By default they are put into the base_resource_pack.
-world <string>		The name of the world to automatically load. It should either be an absolute or relative path to the world folder or the name of the world folder in the user's Minecraft saves folder.
-output <path>		The path of the USD file where MiEx should export the world to. If this argument is specified, MiEx will not show a file dialog on export, but rather immediately start exporting.