This repository has been archived by the owner on Oct 5, 2021. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 50
Recommended Tips to modding with ProjectFNF
actuallyasmartname edited this page May 14, 2021
·
1 revision
When using ProjectFNF, there are a few tips and tricks that you can use to make modding easier.
- When testing your mod, make sure to add
-debug
tolime test windows
. This can go further in detail in crash reasons and you can press F2 to open the haxeflixel debug menu which can help with a lot of things. If it doesn't work, try runninglime test windows -clean
orlime test windows -clean -debug
to fix the issue. - If you use Visual Studio Code, there are extensions that make reading Haxe and Lime files much easier. There are also extensions that make finding errors much easier. Visual Studio Code also has a built in terminal, making compiling the game easier.
- With Visual Studio Code, you can right click while in File Explorer inside the ProjectFNF directory and then click Open with Code and then have access to all the files at once without needing to go back and opening more files.
- Unless you understand .xml files, its best to be careful with changing values in one manually. Programs like Adobe Animate can automatically generate a sprite sheet that works.
- If you don't understand something, you can always join our Discord or create a Issue or even create a Discussion topic. Don't be afraid to ask questions, since ProjectFNF is designed to be easy to learn and is a great place to start modding Friday Night Funkin'
- Watch out for stuff in the Wiki saying its in a future update or was Deprecated. Features that say this will not work in the latest version of the Engine. Feel free to ask why something is Deprecated as well. Its usually because something doesn't work with another thing.
- The config isn't needed but its designed to make the engine easier to modify without needing to understand where the config options are being used.
- Do not edit the metadata in
project.xml
that contains the projectfnf version. This is so if you need help coding, I will be able to see what version your using and if I have fixed the issue. - .xmls do not define where something goes. This is done through code.
- ProjectFNF is constantly being updated and beta tests are frequently released. You can check them out in the Discord!