Friday Night Funkin Synapse Engine

Modding engine created to make modding easier on legacy versions of FNF (<= 0.2.8), made to limit source code editing as much as possible and follow the existing modding methods (V-Slice).

TODO / UPCOMING / PLANNED FEATURES

• Speed-up loading.
• Soft-code the gameplay.
• Implement custom menus.
• Implement Modding using Flixel-Modding and RuleScript.

Credits / shoutouts

• Electr0Gunner - Programmer

• FunkinCrew - FNF Developer Team

Build instructions

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 RELEASES AND DOWNLOAD THE LATEST VERSION (once they release)

IF YOU WANT TO COMPILE THE GAME YOURSELF, CONTINUE READING!!!

Installing the Required Programs

First, you need to install Haxe and HaxeFlixel. I'm too lazy to write and keep updated with that setup (which is pretty simple).

1. Install Haxe
2. Install HaxeFlixel after downloading Haxe

Other installations you'd need are the additional libraries, a fully updated list will be in hmm.json To install them you need to install hmm (Haxe Module Manager) by running

haxelib install hmm
haxelib --global install hmm
haxelib --global run hmm setup
hmm install

You'll also need to install a couple things that involve Gits. To do this, you need to do a few things first.

1. Download git-scm. Works for Windows, Mac, and Linux, just select your build.
2. Follow instructions to install the application properly.

You should have everything ready for compiling the game! Follow the guide below to continue!

Compiling game

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.