Skip to content

Compilation Guide

Jump to bottom
evelyn edited this page May 11, 2026 · 3 revisions

Compilation Guide

Prerequisites

  • Install Haxe >= 4.3.0
  • If on Windows, Install Visual Studio (winget install --id Microsoft.VisualStudio.2022.Community), MSVC build tools v142, and a Windows SDK
  • If on Mac, install Xcode command line tools (xcode-select --install)
  • If on Linux, install a C++ development environment (e.g. base-devel, build-essential)
  • Run haxelib setup {dir}, with {dir} being a directory to store libraries

Setting Up Libraries

To set up Haxe Libraries, open a terminal or command prompt in the lore-engine-legacy directory and run these following commands, in order:

haxelib --global install hmm
haxelib run hmm install
haxelib run lime setup
haxelib run lime setup [windows/mac/linux]
haxelib run lime setup flixel

Compiling

To compile the game, type lime test [platform] (e.g. windows, mac, linux) into your terminal or command prompt.

If you need HaxeFlixel's debugging tools, add -debug to the end of the command.

Lore Engine previously included a separate crash handler, compiled with the -Dbuildcrash flag. A crash handler is now included in the main executable, and this is no longer necessary.

The final files go in export/[debug/release]/[platform]/bin.

Happy mod making!

Clone this wiki locally