-
Notifications
You must be signed in to change notification settings - Fork 3
Building the Engine
THESE INSTRUCTIONS ARE FOR COMPILING THE GAME'S SOURCE CODE!!!
IF YOU WANT TO JUST DOWNLOAD AND INSTALL AND PLAY THE GAME NORMALLY, GO TO ITCH.IO TO DOWNLOAD THE GAME FROM THE RELEASES SECTION!
IF YOU WANT TO COMPILE THE GAME YOURSELF, CONTINUE READING!!!
First, you need to install Haxe and HaxeFlixel. I'm too lazy to write and keep updated with that setup (which is pretty simple).
- Install Haxe 4.2.5 (no longer needed to download a weird outdated version.)
- Install HaxeFlixel after downloading Haxe
Other installations you'd need are the additional libraries, a fully updated list will be in Project.xml in the project root. Currently, these are all of the things you need to install:
flixel
flixel-addons
flixel-ui
hscript
So for each of those type haxelib install [library] so shit like haxelib install newgrounds
You'll also need to install a couple things that involve Gits. To do this, you need to do a few things first.
- Download git-scm. Works for Windows, Mac, and Linux, just select your build.
- Follow instructions to install the application properly.
- Run
haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpcto install Discord RPC.
You should have everything ready for compiling the game! Follow the guide below to continue!
At the moment, you can optionally fix the transition bug in songs with zoomed-out cameras.
- Run
haxelib git flixel-addons https://github.com/HaxeFlixel/flixel-addonsin the terminal/command-prompt.
NOTE: If you see any messages relating to deprecated packages, ignore them. They're just warnings that don't affect compiling
Once you have all those installed, it's pretty easy to compile the game. You just need to run lime test html5 -debug in the root of the project to build and run the HTML5 version. (command prompt navigation guide can be found here: https://ninjamuffin99.newgrounds.com/news/post/1090480)
To run it from your desktop (Windows, Mac, Linux) it can be a bit more involved. For Linux, you only need to open a terminal in the project directory and run lime test linux -debug and then run the executable file in export/release/linux/bin. For Windows, you need to install Visual Studio Community 2019. While installing VSC, don't click on any of the options to install workloads. Instead, go to the individual components tab and choose the following:
- MSVC v142 - VS 2019 C++ x64/x86 build tools
- Windows SDK (10.0.17763.0)
Once that is done you can open up a command line in the project's directory and run lime test windows -debug. Once that command finishes (it takes forever even on a higher end PC), you can run FNF from the .exe file under export\release\windows\bin
As for Mac, 'lime test mac -debug' should work, if not the internet surely has a guide on how to compile Haxe stuff for Mac.
ADDITIONAL NOTE:
if you want to disable the Modding API for your build, add -DNO_MODDING to your command!
COMING SOON