Skip to content

running the program v1

Paweł Waligóra edited this page Sep 17, 2024 · 3 revisions

Usage

Run program with arguments:

mesh-compiler.exe [file to compile] <path to .format file> <output file name>
[file to compile] is mandatory other two are optional.

Program can be run with flags:

  • -f <path to .format file>
  • -o <output file name>

to pass arguments out of order or skip them entirely.

default <path to .format file> is .format
default <output file name> is {file}_{mesh}.mesh

If program was run with no arguments:

mesh-compiler.exe

then > symbol will appear at which point you can enter commands in a same manner as passing arguments when running the program:

for example:
> <file to compile> <path to .format file> <output file name>

or with flags:
> <file to compile> -o <output file name>

> q - closes application

Check version since v1.1.1

If you run the program with just -v or --version version of the mesh compiler will be printed to the console.
Version can be also queried after > symbol

> --version
v1.1.1

.format file

.format files determine the structure of the output file. Meaning what data to extract from input file and in what order / configuration to write that data to output file. See format file syntax v1.1.x for more information about .format files.

Pattern file naming

Single program call can produce numerous output files hence the need for pattern file naming.

Pattern parameters are given in { }.
Possible parameters:

  • {file} - gets replaced by [file to compile] file name without the extension
  • {scene} - gets replaced by scene name defined internally inside file to compile
  • {mesh} - gets replaced by mesh name defined internally inside file to compile

Besides that file can be named normally.

Examples:

  • {scene}_{mesh}.mesh
  • projekt-{mesh}.mesh
  • {file}.mesh

Using {mesh} in file name is highly advised unless you are sure that file contains only one mesh.

Clone this wiki locally