Crow Engine

Info

Crow Engine is a modified version of the game Friday Night Funkin' that has been rebuilt to include comprehensive modding documentation and introduce new features. The primary goal of this project is to facilitate a clearer understanding of modding for players and developers.

Disclaimer

Crow Engine is my passion project, please do not expect any consistency in update schedule.

Mods currently using Crow Engine

• Chill-Sides

Notes

The only official websites for Crow Engine are GitHub, GameBanana, and Twitter.

Credits

The following have contributed to Crow Engine.

• EyeDaleHim - Lead Maintainer & Owner of Crow Engine

• SwickTheGreat - Major Contributor

• AmeliaTheSharmi - Logo Artist

Honorable Mentions

• Rapper GF - Circular Buffer Suggestion

• Cherry - Circular Buffer improvements

Building Instructions

Select the platform you want to compile on and follow the instructions.

Windows

1. Install the latest version of Haxe.
2. Download the Visual Studio Build Tools.
3. Wait for the installer to install any necessary information.
4. Once everything has installed, select the Individual components tab.
5. Select these two components:
   • MSVC v142 - VS 2019 C++ x64/x86 build tools (v14.29-16.11)
   • Windows 10/11 SDK (Any Version)
6. Hit install and wait for the components to install. Once finished, close out of the build tools.
7. Download and install Git SCM. Do not change any installation options, just leave them as is.
8. Navigate to and open your Crow Engine folder. Once in the folder, double-click the update.bat file to open it and install the necessary libraries to compile the engine.
9. After the libraries have been installed, the command prompt should close. Next, click the File button at the top-left of your screen. Select Open Windows PowerShell.
10. In the PowerShell window, type lime build windows and hit enter. This will start building the game. This will also take a bit of time if you are compiling for the first time.
11. Navigate to export/release/windows/bin to find and open the executable.
    • If you want to save yourself some time, run lime test windows in the prompt to open the game right after compilation.

MacOS

1. Install the latest version of Haxe.
2. Download and install Xcode.
3. Download and install Git SCM. Do not change any installation options, just leave them as is.
4. Navigate to and open your Crow Engine folder. Once in the folder, double-click the update.sh file to open it and install the necessary libraries to compile the engine.
5. After the libraries have been installed, the terminal should close. Open a new terminal and set the directory to your Crow Engine folder. This can be done by entering cd [CROW ENGINE FOLDER PATH].
6. Once you have set the directory to your Crow Engine folder, type lime build mac and hit enter. This will start building the game. This will also take a bit of time if you are compiling for the first time.
7. Navigate to export/release/mac/bin to find and open the application.
   • If you want to save yourself some time, run lime test mac in the prompt to open the game right after compilation.

Linux

1. Install the latest version of Haxe.
2. Install g++. If you already have it on your device, you can skip this step.
   • There are many tutorials online and the installation should not be too hard.
3. Download and install Git SCM. Do not change any installation options, just leave them as is.
4. Navigate to and open your Crow Engine folder. Once in the folder, double-click the update.sh file to open it and install the necessary libraries to compile the engine.
   • Some Linux distros don't let you run shell scripts by default. If yours doesn't, run chmod +x [CROW ENGINE FOLDER PATH]/update.sh in a new terminal to allow the shell script to install the libraries.
5. After the libraries have been installed, the terminal should close. Open a new terminal and set the directory to your Crow Engine folder. This can be done by entering cd [CROW ENGINE FOLDER PATH].
6. Once you have set the directory to your Crow Engine folder, type lime build linux and hit enter. This will start building the game. This will also take a bit of time if you are compiling for the first time.
7. Navigate to export/release/linux/bin to find and open the executable.
   • If you want to save yourself some time, run lime test linux in the prompt to open the game right after compilation.