Skip to content

Commit 6cae117

Browse files
authored
Update README.md
1 parent 4fbdc39 commit 6cae117

File tree

1 file changed

+3
-105
lines changed

1 file changed

+3
-105
lines changed

README.md

Lines changed: 3 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11

2+
# Friday Night Funkin' - Mixtape Engine
3+
As the engine is developed, this will be filled out. But for now, this is blank.
4+
25
# Archipelago Randomizer Configuration / Setup Guide
36

47
Archipelago is a Multiworld Randomizer, meaning it randomizes a bunch of games into one randomizer pool, and it challenges you to conplete all of the games.
@@ -20,108 +23,3 @@ When updating the Engine, make sure to use the Update/Install APWorld Button to
2023

2124
### Need help?
2225
Join our [Test Discord Server](https://discord.gg/KJXvEVUfZX) to get assistance with issues, or to submit a bug report.
23-
24-
# Friday Night Funkin' - Psych Engine
25-
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.
26-
27-
## Installation:
28-
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.
29-
30-
Follow a Friday Night Funkin' source code compilation tutorial, after this you will need to install LuaJIT.
31-
32-
To install LuaJIT do this: `haxelib git linc_luajit https://github.com/nebulazorua/linc_luajit` on a Command prompt/PowerShell
33-
34-
...Or if you don't want your mod to be able to run .lua scripts, delete the "LUA_ALLOWED" line on Project.xml
35-
36-
37-
If you get an error about StatePointer when using Lua, run `haxelib remove linc_luajit` into Command Prompt/PowerShell, then re-install linc_luajit.
38-
39-
If you want video support on your mod, simply do `haxelib install hxCodec` on a Command prompt/PowerShell
40-
41-
otherwise, you can delete the "VIDEOS_ALLOWED" Line on Project.xml
42-
43-
## Credits:
44-
* Shadow Mario - Programmer
45-
* RiverOaken - Artist
46-
* Yoshubs - Assistant Programmer
47-
48-
### Special Thanks
49-
* bbpanzu - Ex-Programmer
50-
* shubs - New Input System
51-
* SqirraRNG - Crash Handler and Base code for Chart Editor's Waveform
52-
* KadeDev - Fixed some cool stuff on Chart Editor and other PRs
53-
* iFlicky - Composer of Psync and Tea Time, also made the Dialogue Sounds
54-
* PolybiusProxy - .MP4 Video Loader Library (hxCodec)
55-
* Keoiki - Note Splash Animations
56-
* Smokey - Sprite Atlas Support
57-
* Nebula the Zorua - LUA JIT Fork and some Lua reworks
58-
_____________________________________
59-
60-
# Features
61-
62-
## Attractive animated dialogue boxes:
63-
64-
![](https://user-images.githubusercontent.com/44785097/127706669-71cd5cdb-5c2a-4ecc-871b-98a276ae8070.gif)
65-
66-
67-
## Mod Support
68-
* 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!
69-
* Comes with a Mod Organizing/Disabling Menu.
70-
71-
72-
## Atleast one change to every week:
73-
### Week 1:
74-
* New Dad Left sing sprite
75-
* Unused stage lights are now used
76-
### Week 2:
77-
* Both BF and Skid & Pump does "Hey!" animations
78-
* Thunders does a quick light flash and zooms the camera in slightly
79-
* Added a quick transition/cutscene to Monster
80-
### Week 3:
81-
* BF does "Hey!" during Philly Nice
82-
* Blammed has a cool new colors flash during that sick part of the song
83-
### Week 4:
84-
* Better hair physics for Mom/Boyfriend (Maybe even slightly better than Week 7's :eyes:)
85-
* Henchmen die during all songs. Yeah :(
86-
### Week 5:
87-
* Bottom Boppers and GF does "Hey!" animations during Cocoa and Eggnog
88-
* On Winter Horrorland, GF bops her head slower in some parts of the song.
89-
### Week 6:
90-
* On Thorns, the HUD is hidden during the cutscene
91-
* Also there's the Background girls being spooky during the "Hey!" parts of the Instrumental
92-
93-
## Cool new Chart Editor changes and countless bug fixes
94-
![](https://github.com/ShadowMario/FNF-PsychEngine/blob/main/docs/img/chart.png?raw=true)
95-
* You can now chart "Event" notes, which are bookmarks that trigger specific actions that usually were hardcoded on the vanilla version of the game.
96-
* Your song's BPM can now have decimal values
97-
* You can manually adjust a Note's strum time if you're really going for milisecond precision
98-
* You can change a note's type on the Editor, it comes with two example types:
99-
* Alt Animation: Forces an alt animation to play, useful for songs like Ugh/Stress
100-
* Hey: Forces a "Hey" animation instead of the base Sing animation, if Boyfriend hits this note, Girlfriend will do a "Hey!" too.
101-
102-
## Multiple editors to assist you in making your own Mod
103-
![Screenshot_3](https://user-images.githubusercontent.com/44785097/144629914-1fe55999-2f18-4cc1-bc70-afe616d74ae5.png)
104-
* Working both for Source code modding and Downloaded builds!
105-
106-
## Story mode menu rework:
107-
![](https://i.imgur.com/UB2EKpV.png)
108-
* Added a different BG to every song (less Tutorial)
109-
* All menu characters are now in individual spritesheets, makes modding it easier.
110-
111-
## Credits menu
112-
![Screenshot_1](https://user-images.githubusercontent.com/44785097/144632635-f263fb22-b879-4d6b-96d6-865e9562b907.png)
113-
* You can add a head icon, name, description and a Redirect link for when the player presses Enter while the item is currently selected.
114-
115-
## Awards/Achievements
116-
* 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)
117-
118-
## Options menu:
119-
* You can change Note colors, Delay and Combo Offset, Controls and Preferences there.
120-
* On Preferences you can toggle Downscroll, Middlescroll, Anti-Aliasing, Framerate, Low Quality, Note Splashes, Flashing Lights, etc.
121-
122-
## Other gameplay features:
123-
* When the enemy hits a note, their strum note also glows.
124-
* Lag doesn't impact the camera movement and player icon scaling anymore.
125-
* Some stuff based on Week 7's changes has been put in (Background colors on Freeplay, Note splashes)
126-
* You can reset your Score on Freeplay/Story Mode by pressing Reset button.
127-
* You can listen to a song or adjust Scroll Speed/Damage taken/etc. on Freeplay by pressing Space.

0 commit comments

Comments
 (0)