Skip to content
This repository was archived by the owner on Mar 31, 2025. It is now read-only.

Commit 3d4c382

Browse files
authored
Merge pull request #16451 from SantiagoCalebe/main
A little better README.
2 parents f1fd083 + 8485846 commit 3d4c382

File tree

6 files changed

+20
-4
lines changed

6 files changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Friday Night Funkin' - Psych Engine
1+
![PsychionalEngineLogo](docs/img/PsychEngineLogoTweak.png)
2+
23
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.
34

45
## Installation:
@@ -15,9 +16,14 @@ To start you off, disabling *Video Cutscenes* should be simple, simply delete th
1516

1617
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.
1718

19+
## Softcoding (.lua/.hx)
20+
For this you can head over to [the wiki](https://shadowmario.github.io/psychengine.lua)
21+
22+
There you can learn how to use the 212 PlayState funcions in your mod!
23+
1824
## Credits:
19-
* Shadow Mario - Head Developer, Programmer.
20-
* Riveren - Main Artist.
25+
* Shadow Mario - Main Programmer and Head of Psych Engine.
26+
* Riveren - Main Artist/Animator of Psych Engine.
2127

2228
### Special Thanks
2329
* bbpanzu - Ex-Team Member (Programmer).
@@ -35,18 +41,23 @@ Same goes for *Lua Scripts*, comment out or delete the line with `LUA_ALLOWED`,
3541
* CheemsAndFriends - Creator of FlxAnimate.
3642
* Ezhalt - Pessy's Easter Egg Jingle.
3743
* MaliciousBunny - Video for the Final Update.
38-
_____________________________________
44+
45+
***
3946

4047
# Features
4148

4249
## Attractive animated dialogue boxes:
4350

4451
![Animated Dialogue Boxes](docs/img/dialogue.gif)
4552

53+
## New Main Menu
54+
* A brand new menu that makes your experience even better!
55+
![Main Menu](docs/img/MainMenu.png)
4656

4757
## Mod Support
4858
* 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!
4959
* Comes with a Mod Organizing/Disabling Menu.
60+
![Mod Support](docs/img/ModsMenu.png)
5061

5162

5263
## Atleast one change to every week:
@@ -98,10 +109,12 @@ _____________________________________
98109

99110
## Awards/Achievements
100111
* 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)
112+
![Achievements](docs/img/Achievements.png)
101113

102114
## Options menu:
103115
* You can change Note colors, Delay and Combo Offset, Controls and Preferences there.
104116
* On Preferences you can toggle Downscroll, Middlescroll, Anti-Aliasing, Framerate, Low Quality, Note Splashes, Flashing Lights, etc.
117+
![Options](docs/img/Options.png)
105118

106119
## Other gameplay features:
107120
* When the enemy hits a note, their strum note also glows.
@@ -110,3 +123,6 @@ _____________________________________
110123
* You can reset your Score on Freeplay/Story Mode by pressing Reset button.
111124
* You can listen to a song or adjust Scroll Speed/Damage taken/etc. on Freeplay by pressing Space.
112125
* You can enable "Combo Stacking" in Gameplay Options. This causes the combo sprites to just be one sprite with an animation rather than sprites spawning each note hit.
126+
127+
128+
#### Psych Engine by ShadowMario, Friday Night Funkin' by ninjamuffin99

docs/img/Achievements.png

514 KB
Loading

docs/img/MainMenu.png

439 KB
Loading

docs/img/ModsMenu.png

503 KB
Loading

docs/img/Options.png

558 KB
Loading

docs/img/PsychEngineLogoTweak.png

60.3 KB
Loading

0 commit comments

Comments
 (0)