Psych Engine XTended

This is a fork of Psych Engine 0.6.3 made for its use in the creation of games/mods based on Friday Night Funkin'. It includes all of the features of Psych Engine, plus the additions featured in Vs Selever 2.0 and new ones on their way; basically becoming the next step from the later project.

This engine is being prepared to be the foundation of upcoming games like Funk Guys, as well as other mods I might get involved later on; so this repository will not hold files related to specific FNF mods.

Features

Ported from Psych 0.5.2-xt:

• Automatic loading of dialogues in Story Mode
• Custom dialogue sounds (sounds/dialogue/{character}.ogg) used by default in dialogues
• Localization support for in-game dialogues
• Extended character set for the bitmap font
• Random chance for an alternate menu background (images/menuBGAlt.png and images/menuDesatAlt.png)
• Custom intro text lists in the mods' data folder
• Tweaks in the Lua scripting API

New in 0.6.3-xt:

• Fixes and improvements for the Lua runtime, including callback functions that can be sent from your script to be called once a timer or tween has finished, instead of relying on external events.
• Lua scripting support for custom game states. You can place Lua scripts with the right name in mods/states/ in order to replace existing states (main menu, free play, story mode, etc.) or make completely new ones.

Note: You may check the wiki for more information about these features and how to use them.

Planned Features

New in 0.6.3-xt:

• Some helper Lua utility scripts might come bundled with the stock files.
• Visual editors for stages and modcharts might be added in the future.

Building

If you want to build a copy of this engine by yourself, here's what you need:

• Windows 10 or some compatible system. Virtual machines work well enough.
• Haxe 4.2.5
• HaxeFlixel
• Visual Studio Code
• Visual Code Build Tools 2019: Install modules MSVC v142 - VS 2019 C++ x64/x86 build tools and Windows SDK (10.0.17763.0) only.

Once you've installed all of the mentioned tools, checkout a copy of these files, open a terminal inside the project folder, then execute the following commands:

haxelib --global install hmm
haxelib --global install hxCodec 2.5.1
haxelib run hmm install

Once the setup process is complete, you should be able to build this program. Run the command lime build windows to do it.

Licensing

Any additional code featured in this repository, and not present in Psych Engine, is licensed under the GNU General Public License 3.0. This means you can make use of the released executables for your FNF mod, free of any charges and compromises.

However, if you wish to incorporate any functionality from this project into your own engine, or make a fork of it for customization, you will be required to post your project's sources publicly under the GPL or a license compatible with it. This is for the sake of keeping code stuff free and open; but anything other than code is not affected by this.

Written with StackEdit.