diff --git a/README.md b/README.md index b61ddfd..845c77e 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,9 @@ -# 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. +## Made possible by a heavily modified version of Psych Engine -## 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. +## Dave +this is dave +![Dave](https://cdn.discordapp.com/attachments/826922537668968478/884915478592643102/this_is_dave.png) -open up a Command Prompt/PowerShell or Terminal, type `haxelib install hmm` +say hi to dave! -after it finishes, simply type `haxelib run hmm install` in order to install all the needed libraries for *Psych Engine!* - -## Customization: - -if you wish to disable things like *Lua Scripts* or *Video Cutscenes*, you can read over to `Project.xml` - -inside `Project.xml`, you will find several variables to customize Psych Engine to your liking - -to start you off, disabling Videos should be simple, simply Delete the line `"VIDEOS_ALLOWED"` or comment it out by wrapping the line in XML-like comments, like this `` - -same goes for *Lua Scripts*, comment out or delete the line with `LUA_ALLOWED`, this and other customization options are all available within the `Project.xml` file - -## Credits: -* Shadow Mario - Programmer -* RiverOaken - Artist -* Yoshubs - Assistant Programmer - -### Special Thanks -* bbpanzu - Ex-Programmer -* Yoshubs - New Input System -* SqirraRNG - Crash Handler and Base code for Chart Editor's Waveform -* KadeDev - Fixed some cool stuff on Chart Editor and other PRs -* iFlicky - Composer of Psync and Tea Time, also made the Dialogue Sounds -* PolybiusProxy - .MP4 Video Loader Library (hxCodec) -* Keoiki - Note Splash Animations -* Smokey - Sprite Atlas Support -* Nebula the Zorua - LUA JIT Fork and some Lua reworks -_____________________________________ - -# Features - -## Attractive animated dialogue boxes: - -![](https://user-images.githubusercontent.com/44785097/127706669-71cd5cdb-5c2a-4ecc-871b-98a276ae8070.gif) - - -## 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 -![](https://github.com/ShadowMario/FNF-PsychEngine/blob/main/docs/img/chart.png?raw=true) -* 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 -![Screenshot_3](https://user-images.githubusercontent.com/44785097/144629914-1fe55999-2f18-4cc1-bc70-afe616d74ae5.png) -* Working both for Source code modding and Downloaded builds! - -## Story mode menu rework: -![](https://i.imgur.com/UB2EKpV.png) -* Added a different BG to every song (less Tutorial) -* All menu characters are now in individual spritesheets, makes modding it easier. - -## Credits menu -![Screenshot_1](https://user-images.githubusercontent.com/44785097/144632635-f263fb22-b879-4d6b-96d6-865e9562b907.png) -* 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. +hi dave \ No newline at end of file