README.md

This is a fork from tposejank / FNF-PsychEngine-ExtraKeys

Friday Night Funkin' - BEAT! Engine

Engine was made using a lot of different Source Codes.

• Made/Modified in Brazil (Yeah, Brazil Moment 🇧🇷).

Social Media

• Discord Server
• Twitter

Compiling

Dependencies

• Git
• Haxel (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

Downloads

Git

for Windows and Mac: https://git-scm.com/downloads

• after installing, open a Command Prompt or Terminal, and type in: haxelib setup

Linux (Ubuntu and Debian based Distros):

• sudo apt-get update
• sudo apt-get install git -y

Linux (Arch based Distros):

• sudo pacman -Sy git --noconfirm

Haxe

Windows and Mac: https://haxe.org/download/ (Latest Version)

Linux (Ubuntu and Debian based Distros):

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

Linux (Arch based Distros)

• sudo pacman -Sy haxe --noconfirm

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 "Workloads" tab, select "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)

Once it's done, do this command to compile the game

Windows

lime test windows

Linux

lime test linux

Mac

lime test mac

for Debug Builds

add a "-debug" flag at the end of "lime test "

Visual Studio Code Installation

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

Linux (Ubuntu and Debian based Distros):

• sudo apt install software-properties-common apt-transport-https wget
• wget -q https://packages.microsoft.com/keys/microsoft.asc -O- | sudo apt-key add -
• sudo add-apt-repository "deb [arch=amd64] https://packages.microsoft.com/repos/vscode stable main"
• sudo apt install code

Linux (Arch based distros):

• sudo pacman -Sy code

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

───────────────────────────────────────────────────────────────────────────

BEAT! Engine

• AquaStrikr - Art, Director, Charting
• Luisinhi010 - Coding, Animation, Charting
• Gui-iago - Additional Coding, Charting
• NooBZiiTo - Animation
• Re.Xuadoz.2.5 - Ideas

Psych Engine

• Shadow Mario - Engine Developer
• RiverOaken - Arts and Animations
• bbpanzu - Assistant Programmer
• tposejank - Psych Extra Keys

Special Thanks

• Salt for Some Reason - Logo
• AshoXD - Rich Presence Header Design
• El_Cyaan - Guns Mania Chart, GF ALT, BanduFrein
• LeNinethGames - Menu Remix
• a gorila guy/Renan - Parasite Cover (Composed by TheInnuendo)
• superpowers04 - Character Selection Script
• shubs - New Input System
• SqirraRNG - Chart Editor's Sound Waveform base code
• iFlicky - Delay/Combo Menu Song Composer + Dialogue Sounds
• PolybiusProxy - .MP4 Loader Extension
• Keoiki - Note Splash Animations
• Smokey - Spritemap Texture Atlas support
• gedehari - Chart Editor's Sound Waveform base
• Cary - OG Resolution code
• Nebula_Zorua - VCR Shader code

Kade Engine

• KadeDev - Input and Time Bar

TheZoroForce240

• TheZoroForce240 - Input

Skin Credits

• Uniianimates - BF/GF (High Effort Erect Remixes)
• CarKeys - BF/GF (Just a Little BF/GF Remake)
• Luisinhi010 - ALT BoyFriend (BEAT!Engine BF)
• NooBZiiTo - Scarf Pico, X-Mas Mommy Mearest (Scarf Pico, based on Phantom Fear's Design and X-mas MM based on Week 5's outfit)
• theoriginalalex - Only Speakers/No GF Skin
• kazzyrus - Mommy Mearest over GF Skin

Features

Mania Difficulty + Charts

• Extra Keys and Charts for all weeks (Even Tutorial)

high_6K.mp4

Revamped Menu

• Transitions Based on Mic'd Up Engine
• Random Icon appearing on the screen (also changes the Icon BG Color)
• Socials Button (Discord and Twitter)

Simplified Menu Option

• This option was created for Low End Devices, Simplifies the Main Menu in order to decrease Loading times and improve performance
• May not decrease the loading so much, because still use one of the large file of the main menu (the bg)

Osu! Lazer Style Menu (Alt Menu, UPCOMING)

• Osu! Menu, if you like Osu! Lazer

Xtras

• Winning Icons
• New Health Bar
• Multiple Inputs
• New Grafix (Marvelous, Sick, Good, Bad, Shit)
• Opponent Mode (Yeah, you can play as the opponent, but it's rlly funkin' cool, y'know?)
• AND MORE!