InkC is a port of Inkle's Ink narrative scripting engine to the C programming language.

The project is written in pure C99 with no non-standard extensions, as God intended.

InkC is very early in development. As such, a small subset of features is currently supported with numerous caveats.

A significant deviation from the reference implementation is the inclusion of lexical scoping.

Source files also currently only support the US-ASCII character set.

# Quick Makefile wrapper method
make

# CMake method
cmake -DCMAKE_BUILD_TYPE=Debug -B build
cd build
make

inkc [OPTION]... [FILE]
Load and execute an Ink story.

  -h, --help       Print this message
  --colors         Enable color output
  --compile-only   Compile the story without executing
  --dump-ast       Dump a source file's AST
  --dump-story     Dump a story's bytecode
  --trace          Enable execution tracing
  --trace-gc       Enable garbage collector tracing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

The development toolchain requires the following:

• LLVM (clang, clang-format, lit)
• Python
• Pip
• CMocka
• Pre-commit

All commits must first be processed by pre-commit hooks. Before you can run hooks, you must have the pre-commit package manager installed.

Using pip:

pip install pre-commit

All commit messages should follow the Conventional Commits standard.

MIT