Friday Night Funkin' - Bedrock Engine!

a fork of Psych Engine which adds a bunch of features from Pull Requests around the Main Branch, and even other forks! Credits:

BURGER76920 - Json-editable Menus
CerBor - Difficulty Drop Down on Chart Menu
HiroMizuki - Pixel Note Splashes
i-winxd - Kade Engine (Complex) Accuracy
lemz1 - Play as Opponent
l1ttleO - Made ProjectFNF 2.X, Original Hit Sound Code, Miss Sounds Toggle
magnumsrtisswag - Credits Warning
Starmapo - Time Signatures
Stilic - Freeplay Bump, Max Optimization, Menu Animations, Automatic Controller Detection
Verwex - made Mic'd Up Engine, Winning Icons
XtraXD1 - Show/Hide Weeks temporally + Getting/Setting on Source Code
Yoshubs - made Forever Engine, Main Inspiration

Remember: this engine should be treated as nothing but a Mod/Fork of Psych Engine

Sections:

How to Compile the Game, and what is needed to do so

Dependencies

Git
Haxe (LATEST VERSION ONLY, PLEASE, STOP USING 4.1.5!!!!)
Visual Studio Community (Windows Only)

OPTIONAL Dependencies

Visual Studio Code (for modifying the code itself)

Recommended VS Code Extensions

Lime
Bracket Pair Colorizer 2
HXCPP Debugger
Tabnine

Optional Visual Studio Code Extensions

Haxe blocks
Haxe Checkstyle
Haxe JSX
Haxe Extension Pack
HaxeUI
indent-rainbow
Lua Extension by keyring

Compiling Dependencies

Git & Haxe

Windows and macOS:

macOS with homebrew:

brew install git
brew install haxe

Ubuntu based Linux distros:

sudo add-apt-repository ppa:haxe/releases -y
sudo apt update
sudo apt install git haxe -y
mkdir ~/haxelib && haxelib setup ~/haxelib

Debian based Linux distros:

sudo apt-get install git haxe -y
mkdir ~/haxelib && haxelib setup ~/haxelib

Arch based Linux distros:

sudo pacman -S git haxe
mkdir ~/haxelib && haxelib setup ~/haxelib

Redhat based Linux distros:

sudo dnf install git haxe -y
mkdir ~/haxelib && haxelib setup ~/haxelib

openSuse based Linux distros:

sudo zypper install git haxe
mkdir ~/haxelib && haxelib setup ~/haxelib

Post installation on all platforms, run

haxelib setup

Visual Studio Community

https://my.visualstudio.com/Downloads?q=visual%20studio%202017&wt.mc_id=o~msft~vscom~older-downloads

Visual Studo Community Setup

Once you download and install VS Community, on the "Individual Components" tab, select:

MSVC v142 - VS 2019 C++ x64/x86 build tools
Windows SDK (10.0.17763.0)

Desktop Development with C++ Near the "Install" button, there's a Drop-Down menu, click on it, Select "Download first, then Install" Now wait until it finishes, it is recommended to reboot your PC once it finishes, but it's not needed at all

Terminal Setup & Compiling Game

Windows: Press "Windows + R" and type in "cmd", if you don't like cmd, or you just use something different, open that program instead cmd is usually faster, that's why I'm recommending it!

Linux: press "CTRL + ALT + T" and a Terminal window should open -- although, if you are on linux, you probably know that already

Type in these commands:

haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc
haxelib git linc_luajit https://github.com/nebulazorua/linc_luajit.git
haxelib git hxvm-luajit https://github.com/nebulazorua/hxvm-luajit
haxelib git faxe https://github.com/uhrobots/faxe
haxelib git polymod https://github.com/MasterEric/polymod.git
haxelib git extension-webm https://github.com/KadeDev/extension-webm
haxelib install lime 7.9.0
haxelib install openfl
haxelib install flixel
haxelib install flixel-tools
haxelib install flixel-ui
haxelib install hscript
haxelib install flixel-addons
haxelib install actuate
haxelib run lime setup
haxelib run lime setup flixel
haxelib run flixel-tools setup

Read Carefully: When it prompts for you to do anything (like: setup the lime command, setup flixel tools, etc)

Compiling test version:

lime test PLATFORM # linux, windows, mac

for Debug Builds

Append -debug at the end of lime test PLATFORM

Visual Studio Code Installation

Windows and Mac: https://code.visualstudio.com/Download

Linux: https://code.visualstudio.com/docs/setup/linux

Alternatively, you can use your distro's package manager to install Visual Studio Code

In case you don't want your mod to be able to run .lua scripts, delete the LUA_ALLOWED line on Project.xml

Current Features

All Psych Engine Features!

Being a Psych Engine fork has it's Perks

Menu Animations and Freeplay Bump

2022-01-25.15-25-41.mp4

Hit Sounds

2022-01-25.15-30-57.mp4

More Perfomance Options

some more Performance Options for the game to run smoothly on older hardware

Hide Girlfriend

it's in the name!

this also comes with special dialogue for Week 6!

Max Optimization

this disables everything related to backgrounds and characters, leaving only the HUD and Note Splashes!

Letter Grading System!

SS 100% Accuracy.
S+ 99% Accuracy.
A+ 95% Accuracy
A 89% Accuracy.
B 79% Accuracy.
C 69% Accuracy.
D 40% Accuracy or below.

If you do not want the engine to use letter grades, toggle then using the gameplaySettings.json file on the settings folder.

FC Ratings

MFC - Full Combo with Only Marvelouses (can be disabled)
SFC - Full Combo with at least 1 Sick/Only Sicks
GFC - Full Combo with at least 1 Good/Only Goods
FC - Full Combo with at least 1 Bad/Only Bads (only works on Simple Accuracy)
SDB - Single Digit Bad (at least 1 Bad/Only Bads, only works on Complex Accuracy)
SDS - Single Digit Shit (at least 1 Shit/Only Shits)
SDCB - Single Digit Combo Break (you missed at least once)
Clear - You missed at least 10 times