Friday Night Funkin': Eternal

Eternal is a Friday Night Funkin' modding framework/engine designed from the ground up, which takes heavy inspiration from the base game to build a unique experience. It aims to be user friendly and easy-to-use while still being extremely moddable.

Note

• This project is still in development, meaning some features such as dialogue cutscenes are still missing.
• For any questions, don't hesitate to message me on Discord, @sword_352
• Feedback is always appreciated and contributions are welcome!

Licensing

Any of the code made for this project is licensed under the GPL v3 software license, but it's terms aren't necessarly enforced, so decisions can be taken at your own will as long as you don't cross the line with our developer team.

Some of this project's assets are owned by or are derived from work by the Funkin' Crew. These assets have specific licensing requirements, see the official repository for more information.

Any of the assets made by our developer team can be used, modified and/or distributed as long as they are used for a mod built with Eternal or a fork of the project, without exploitation or commercial purposes.

For any doubts, make sure to contact me.

Building

1. Install the latest version of Haxe
2. Install git-scm
3. If you're looking to compile to a C++ target, some extra dependencies are required based on your OS:

Windows

• Install the Visual Studio Build Tools and wait for the installer to be ready
• Select the Individual Components tab and choose those 2 components:
  • MSVC v143 VS 2022 C++ x64/x86 build tools
  • Windows 10/11 SDK
• Click on install and wait for the components to be installed, you can safely close the program once finished

MacOS

• Install Xcode

Linux

• Install g++ if required:
  • sudo apt install gcc g++ for Debian-based distros
  • sudo pacman -S gcc g++ for Arch-based distros

4. With a command prompt, install and setup the hxpkg library by following the steps from it's official repository.
5. Run hxpkg install --global to install the librairies this project depends on. Note that:
   • The --global flag is optional. If not included, the librairies are installed locally (in the root directory of your installation).
   • If targetting a C++ target such as Windows, it is recommended to run hxpkg install cpp --global instead to include extra librairies used in C++ targets.

After those steps, you can build the project with a command prompt by running the appropriate building command for your target, such as lime test windows.

Special Thanks

TBD