Skip to content
This repository was archived by the owner on Nov 14, 2024. It is now read-only.

Compiling

Jump to bottom
Joalor64 edited this page Jul 28, 2022 · 15 revisions

Compiling

If you want to build the game yourself or build it with a mod, here's how to do it.

How to Compile

Windows / Mac / Linux

You must have the most up-to-date version of Haxe. Seriously, stop using 4.1.5, it misses some stuff.

Then, follow the Friday Night Funkin' Source Code Guide. After you do this, you will need to install LuaJIT.

To install LuaJIT, put this command in Command Prompt or Powershell: haxelib git linc_luajit https://github.com/nebulazorua/linc_luajit

If you get an error about StatePointer when using Lua, run haxelib remove linc_luajit in Command Prompt or PowerShell, then re-install linc_luajit.

After that, install every dependency required for this thing to run.

Last but not least, if you don't want your mod to be able to run .lua scripts, delete the "LUA_ALLOWED" line on Project.xml.

Or if you don't want your mod to be able to run .hscript scripts, delete the "HSCRIPT_ALLOWED" line.

If you want video support on your mod, simply run haxelib install hxCodec on a Command Prompt or PowerShell. Otherwise, you can delete the "VIDEOS_ALLOWED" line.

If you don't want MP3 or WAV support, remove the "MP3_ALLOWED" and "WAV_ALLOWED" lines.

Once the game is compiled, the output will be generated in either of the following paths:

  • (export/release/windows/bin)
  • (export/release/macos/bin)
  • (export/release/linux/bin)

If the game is compiled as a debug build, the output will be generated in either of these paths:

  • (export/debug/windows/bin)
  • (export/debug/macos/bin)
  • (export/debug/linux/bin)

Android (Support for Android will be added soon...)

  1. Download the following:
  1. After downloading, do the following:
  • Install JDK
  • Install Android Studio
  • Unzip NDK (No Installation Required)
  1. Setup Android Studio

To do this, go to Android Studio itself, and go to (Settings ->Appearance & Behavior->System Settings->Android SDK). andr andr2

  1. In Command Prompt or Powershell, run the command lime setup android.

As seen in the screenshot below, you should use JDK. Not JRE. lime

  1. Install extension-androidtools, extension-videoview and replace the linc_luajit.

To install, open up Command Prompt or Powershell and type the following:

haxelib git extension-androidtools https://github.com/jigsaw-4277821/extension-androidtools.git

haxelib git extension-videoview https://github.com/jigsaw-4277821/extension-videoview.git

haxelib remove linc_luajit

haxelib git linc_luajit https://github.com/jigsaw-4277821/linc_luajit.git
  1. Open the project in the command line and use this command:

lime build android -final

The APK will be generated in this path:

(export/release/android/bin/app/build/outputs/apk/debug)

If compiled as a debug, the APK will be generated in this path:

(export/debug/android/bin/app/build/outputs/apk/debug)

Yeah.

That's basically it.

Clone this wiki locally