forked from ShadowMario/FNF-PsychEngine
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,103 +1,3 @@ | ||
| # Friday Night Funkin' - Psych Engine | ||
| Engine originally used on [Mind Games Mod](https://gamebanana.com/mods/301107), intended to be a fix for the vanilla version's many issues while keeping the casual play aspect of it. Also aiming to be an easier alternative to newbie coders. | ||
|
|
||
| ## Installation: | ||
| You must have [the most up-to-date version of Haxe](https://haxe.org/download/), seriously, stop using 4.1.5, it misses some stuff. | ||
|
|
||
| Follow a Friday Night Funkin' source code compilation tutorial, after this you will need to install LuaJIT. | ||
|
|
||
| To install LuaJIT do this: `haxelib git linc_luajit https://github.com/nebulazorua/linc_luajit` on a Command prompt/PowerShell | ||
|
|
||
| ...Or if you don't want your mod to be able to run .lua scripts, delete the "LUA_ALLOWED" line on Project.xml | ||
|
|
||
|
|
||
| If you get an error about StatePointer when using Lua, run `haxelib remove linc_luajit` into Command Prompt/PowerShell, then re-install linc_luajit. | ||
|
|
||
| If you want video support on your mod, simply do `haxelib install hxCodec` on a Command prompt/PowerShell | ||
|
|
||
| otherwise, you can delete the "VIDEOS_ALLOWED" Line on Project.xml | ||
|
|
||
| ## Credits: | ||
| * Shadow Mario - Coding | ||
| * RiverOaken - Arts and Animations | ||
| * bbpanzu - Assistant Coding | ||
|
|
||
| ### Special Thanks | ||
| * 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 | ||
| * Cary - OG Resolution code | ||
| * Nebula_Zorua - VCR Shader code | ||
| _____________________________________ | ||
|
|
||
| # Features | ||
|
|
||
| ## Attractive animated dialogue boxes: | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Mod Support | ||
| * Probably one of the main points of this engine, you can code in .lua files outside of the source code, making your own weeks without even messing with the source! | ||
| * Comes with a Mod Organizing/Disabling Menu. | ||
|
|
||
|
|
||
| ## Atleast one change to every week: | ||
| ### Week 1: | ||
| * New Dad Left sing sprite | ||
| * Unused stage lights are now used | ||
| ### Week 2: | ||
| * Both BF and Skid & Pump does "Hey!" animations | ||
| * Thunders does a quick light flash and zooms the camera in slightly | ||
| * Added a quick transition/cutscene to Monster | ||
| ### Week 3: | ||
| * BF does "Hey!" during Philly Nice | ||
| * Blammed has a cool new colors flash during that sick part of the song | ||
| ### Week 4: | ||
| * Better hair physics for Mom/Boyfriend (Maybe even slightly better than Week 7's :eyes:) | ||
| * Henchmen die during all songs. Yeah :( | ||
| ### Week 5: | ||
| * Bottom Boppers and GF does "Hey!" animations during Cocoa and Eggnog | ||
| * On Winter Horrorland, GF bops her head slower in some parts of the song. | ||
| ### Week 6: | ||
| * On Thorns, the HUD is hidden during the cutscene | ||
| * Also there's the Background girls being spooky during the "Hey!" parts of the Instrumental | ||
|
|
||
| ## Cool new Chart Editor changes and countless bug fixes | ||
|  | ||
| * You can now chart "Event" notes, which are bookmarks that trigger specific actions that usually were hardcoded on the vanilla version of the game. | ||
| * Your song's BPM can now have decimal values | ||
| * You can manually adjust a Note's strum time if you're really going for milisecond precision | ||
| * You can change a note's type on the Editor, it comes with two example types: | ||
| * Alt Animation: Forces an alt animation to play, useful for songs like Ugh/Stress | ||
| * Hey: Forces a "Hey" animation instead of the base Sing animation, if Boyfriend hits this note, Girlfriend will do a "Hey!" too. | ||
|
|
||
| ## Multiple editors to assist you in making your own Mod | ||
|  | ||
| * Working both for Source code modding and Downloaded builds! | ||
|
|
||
| ## Story mode menu rework: | ||
|  | ||
| * Added a different BG to every song (less Tutorial) | ||
| * All menu characters are now in individual spritesheets, makes modding it easier. | ||
|
|
||
| ## Credits menu | ||
|  | ||
| * You can add a head icon, name, description and a Redirect link for when the player presses Enter while the item is currently selected. | ||
|
|
||
| ## Awards/Achievements | ||
| * The engine comes with 16 example achievements that you can mess with and learn how it works (Check Achievements.hx and search for "checkForAchievement" on PlayState.hx) | ||
|
|
||
| ## Options menu: | ||
| * You can change Note colors, Delay and Combo Offset, Controls and Preferences there. | ||
| * On Preferences you can toggle Downscroll, Middlescroll, Anti-Aliasing, Framerate, Low Quality, Note Splashes, Flashing Lights, etc. | ||
|
|
||
| ## Other gameplay features: | ||
| * When the enemy hits a note, their strum note also glows. | ||
| * Lag doesn't impact the camera movement and player icon scaling anymore. | ||
| * Some stuff based on Week 7's changes has been put in (Background colors on Freeplay, Note splashes) | ||
| * You can reset your Score on Freeplay/Story Mode by pressing Reset button. | ||
| * You can listen to a song or adjust Scroll Speed/Damage taken/etc. on Freeplay by pressing Space. | ||
| # HBot | ||
| ## DOWNLOAD THE SOURCE CODE FROM THE RELEASE, AS I HAVE NO IDEA HOW PULL REQUESTS WORK | ||
| bot |