Skip to content

Commit e728090

Browse files
committed
Merge remote-tracking branch 'upstream'
2 parents d100b93 + 7f6bb1e commit e728090

File tree

1 file changed

+9
-24
lines changed

1 file changed

+9
-24
lines changed

README.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1+
# NOTE: This engine is abandoned! If there are any bugs or glitches, they'll be left unfixed. I'm keeping it up for archival purposes and because some mods have used it.
2+
13
![Psych Engine Extra](https://user-images.githubusercontent.com/85134252/153526241-9f265b56-ffd1-4452-bb61-c7500471a910.png)
24

35
# Friday Night Funkin' - Psych Engine Extra
46
Modified version of Psych Engine adding more stuff, most notably higher key amounts, time signatures, and Hscript support.
57

68
## Credits:
7-
* Moxie - Maintainer of this Fork
8-
* Starmapo - Creator, Programmer and Artist
9+
* Starmapo - Programmer and Artist
910

1011
## Special Thanks:
1112
* KadeDev & GitHub Contributors - Made Kade Engine (some code and ideas are from there)
@@ -15,6 +16,7 @@ Modified version of Psych Engine adding more stuff, most notably higher key amou
1516
## Psych Engine Credits:
1617
* Shadow Mario - Programmer
1718
* RiverOaken - Artist
19+
* Yoshubs - Assistant Programmer
1820

1921
### Psych Engine Special Thanks:
2022
* bbpanzu - Ex-Programmer
@@ -54,36 +56,19 @@ _____________________________________
5456

5557
## Build Instructions:
5658
### Installing the Required Programs
57-
First, you need to install the **latest** Haxe (4.3.7) and HaxeFlixel (5.2.2). I'm too lazy to write and keep updated with that setup (which is pretty simple).
59+
First, you need to install the **latest** Haxe and HaxeFlixel. I'm too lazy to write and keep updated with that setup (which is pretty simple).
5860
1. [Install Haxe](https://haxe.org/download/)
5961
2. [Install HaxeFlixel](https://haxeflixel.com/documentation/install-haxeflixel/) after downloading Haxe (make sure to do `haxelib run lime setup flixel` to install the necessary libraries, basically just follow the whole guide)
6062

61-
For this project, you'll need to do `haxelib newrepo` and then install the following libaries listed here
62-
```
63-
haxelib install lime 8.2.2
64-
haxelib install openfl 9.2.2
65-
haxelib --never install flixel 5.2.2
66-
haxelib install flixel-tools
67-
haxelib set flixel-ui 2.6.0 --always
68-
haxelib set flixel-addons 2.11.0 --always
69-
haxelib install hxCodec 2.5.1
70-
haxelib git linc_luajit https://github.com/superpowers04/linc_luajit
71-
haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc
72-
haxelib git hscript https://github.com/HaxeFoundation/hscript
73-
haxelib git hscript-ex https://github.com/moxie-coder/hscript-ex
74-
haxelib set openfl 9.2.2 --always
75-
```
76-
Make *sure* you use OpenFL 9.2.2 and Lime 8.2.2 for this specifically. Which is what the local haxelib is for.
77-
78-
<!-- You should make sure to keep Haxe & Flixel updated. If there is a compilation error, it might be due to having an outdated version. -->
63+
You should make sure to keep Haxe & Flixel updated. If there is a compilation error, it might be due to having an outdated version.
7964

8065
You'll also need to install a couple things that involve Gits. To do this, you need to do a few things first.
8166
1. Download [git-scm](https://git-scm.com/downloads). Works for Windows, Mac, and Linux, just select your build.
8267
2. Follow instructions to install the application properly.
8368
3. Run `haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc` to install Discord RPC.
84-
4. Run `haxelib git linc_luajit https://github.com/superpowers04/linc_luajit` to install LuaJIT. 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 don't want your mod to be able to run .lua scripts, delete the "LUA_ALLOWED" line on Project.xml)
85-
5. Run `haxelib git hscript https://github.com/HaxeFoundation/hscript` to install hscript. After that, run `haxelib git hscript-ex https://github.com/moxie-coder/hscript-ex/` to install hscript-ex. (If you don't want your mod to be able to run .hscript scripts, delete the "HSCRIPT_ALLOWED" line on Project.xml)
86-
6. Run `haxelib install hxCodec 2.5.1` to install hxCodec for video support. (If you don't want your mod to have video support, delete the "VIDEOS_ALLOWED" line on Project.xml)
69+
4. Run `haxelib git linc_luajit https://github.com/nebulazorua/linc_luajit` to install LuaJIT. 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 don't want your mod to be able to run .lua scripts, delete the "LUA_ALLOWED" line on Project.xml)
70+
5. Run `haxelib git hscript https://github.com/HaxeFoundation/hscript` to install hscript. After that, run `haxelib git hscript-ex https://github.com/ianharrigan/hscript-ex` to install hscript-ex. (If you don't want your mod to be able to run .hscript scripts, delete the "HSCRIPT_ALLOWED" line on Project.xml)
71+
6. Run `haxelib install hxCodec` to install hxCodec for video support. (If you don't want your mod to have video support, delete the "VIDEOS_ALLOWED" line on Project.xml)
8772

8873
You should have everything ready for compiling the game! Follow the guide below to continue!
8974

0 commit comments

Comments
 (0)