Importer

Import settings

Is Main Story

This setting decides whether the file is actually compiled and imported or not. This is the best compromise for now to avoid issues with multiple .ink files referencing each other.

The short story is: files you're going to load as entry points need this to be checked. Others don't.

✋ Be aware that for now, files that aren't flagged as main won't trigger a recompilation of the main file.

For the long story, imagine the following three .ink files.

# Main.ink
INCLUDE Foo.ink
INCLUDE Bar.ink
-> Foo

# Foo.ink
=== Foo
Hello World -> Bar

# Bar.ink
=== Bar
-> DONE

If we leave the importer to compile each file separately, it'll fail on Foo.ink because it references an unknown knot named Bar. In addition, since the included content is copied in place during compilation, we really don't need to waste space by including them twice in the game.

A better solution for this could rely on this proposal allowing us to automatically skip files we don't want to compile.

Compress

This setting will toggle the ZSTD compression on the final imported file. It'll use the compression settings defined globally in your project.