Friday Night Funkin' - Codename Engine

Codename Engine is a cross platform Friday Night Funkin' Engine aimed at simplifying modding focusing on softcoding, along with extensiblity and ease of use.
It is the the official successor of the previously well known Yoshi Engine.

The engine uses HaxeFlixel and it mainly features:

• A full scripting system with an optimized fork of Hscript (its name is Hscript Improved)
• Uses forks of popular libraries tailored specifically for the engine for the goal of better optimization.
• Modding system and softcoding is as capable as source coding.
• Focuses heavily on optimization, and encourages its users to also take on optimization practices.
• Many modding tools without changing the core gameplay and the base to mod on.
• Allows modularity using addons and mods that apply on top of the core mod.
• Advanced editors which allows for possibly better experience and easiness when creating the mod.
• Much more can be read HERE

Note

Please keep in mind that, despite these differences, we do not consider our engine to be any better or worse than the others.

---

Caution

Want to use this project's code for different purposes or something similar? Check out the Usage Info part below first, it basically explains what you can do or not do!
We love open source but we also love proper credits for having respect of all the people who worked hard on this project!!

Warning

Before making issues or if you need help with something, check our website HERE.
It contains a wiki of how to mod with EXAMPLES, an api, lists of mods made with Codename Engine and more!

Tip

Want to stay updated with this project?
Check out our patch notes!

---

---

Note

Codename Engine as for now supports Windows x64, Mac OS x64 and Linux x64.
More platforms will soon come, stay tuned!

• Web (HTML5) Support
• Mobile Support

How to download

• Stable builds of the engine can be found on our GameBanana or our itch.io pages.
• Latest EXPERIMENTAL builds of the engine can be found in the Actions tab. REQUIRES A GITHUB ACCOUNT!!

If you don't have a GitHub account to download experimental builds, you can also go onto our official website and click the download button for the respective operating system under the Experimental section.

How to mod

Check out our wiki HERE

How to setup and build

Check out our guide HERE

Usage Info

Feel free to:

• Download and play the engine with its mods and modpacks
• Mod and fork the engine (without using it for illicit purposes)
• Contribute to the engine (for example through Pull Requests, Issues, etc.)
• Create a sub engine with Codename Engine as TEMPLATE with CREDITS (for example leaving the credits menu submenu with the GitHub contributors and putting the main devs in a README specifying that it's a sub engine from Codename Engine)
• Release excutable mods that use Codename Engine as source (specifing that uses Codename Engine by for example the same way written above this)
• Release Codename Engine modpacks

Please do not:

• Create a side/new/etc engine (or mod that doesn't use Codename Engine) using Codename Engine's code
• Steal code from Codename Engine for another different project that is not Codename Engine related (Codename Engine mods excluded) without properly crediting
• Release the entirety of Codename Engine on platforms (mods that use Codename Engine as source are fine)

If you need more info or feel like asking to do something which is not listed here, ask us directly on our discord server!

Credits

• All main Credits can be seen inside the Engine and specifically HERE
• Credits to the FlxAnimate team for the Animate Atlas support
• Credits to Smokey555 for the backup Animate Atlas to spritesheet code
• Credits to MAJigsaw77 for hxvlc (video cutscene/mp4 support) and hxdiscord_rpc (discord rpc integration)
• Credits to TheoDev for FunkinModchart. (library used for modcharting features)
• Credits to Ninjamuffin99 and the Funkin Crew for the base game Friday Night Funkin'

Mobile Credits

• Credits to MaysLastPlay - Main Developers
• Credits to Dechis - Main Developers
• Credits to Stefan2008 - Helper
• Credits to JustX/GreenColdTea - Helper and Reworking Lime for Gradle Shit
• Credits to Cream.BR - Extra Buttons on Hitbox/VPad
• Credits to Idklool - Used most of his Mobile Code (Hitbox and VPad Codes)
• Credits to Fox2 - Tester
• Credits to Vermilion - Tester
• Credits to Limon - Tester

What can you do or not do with this Mobile Port

You can:

• Download and play the engine port with its mods and modpacks
• Mod and fork the engine port (without using it for illicit purposes)
• Contribute to the engine port (for example through Pull Requests, Issues, etc)
• Release APK/IPA bundle mods that uses our Codename Engine Mobile Port as source (Specifing that uses our Codename Engine Mobile Port by for example crediting us if you gonna release your bundle)

You can't:

• Steal code from Codename Engine Mobile Port for another different project that is not related to our Codename Engine Mobile Port (Codename Engine mods excluded) without asking if you can use

Warnings for Codename Official Devs:

• If you are a dev from Codename Engine, you can bypass all of theses rules

ALL THE OTHER RULES STILL APPLYS TO THIS PORT, THIS IS JUST SPECIFIED RULES FOR OUR MOBILE PORT

If you need more info or feel like asking to do something which is not listed here, ask us on our Community Server (Mays Server)!