search

FNF-CNE-Devs / CodenameEngine

awesome fnf engine :D
Apache License 2.0
253 stars 172 forks source link

readme

Friday Night Funkin' - Codename Engine (WIP)

PLEASE NOTE - THIS IS STILL IN A BETA STATE

Mods created with beta versions of Codename may not be compatible with the release version

Known issues in the beta:

Build instructions are below. Press TAB on the main menu to switch mods.

Also, the command .\cne test uses the source assets folder instead of the export one for easier development (Although you can still use lime test windows normally).

Codename Engine

Codename Engine is a new Friday Night Funkin' Engine aimed at simplifying modding, along with extensiblity and ease of use.
Make sure to read the wiki and join the Discord server linked there!

It includes many new features, as seen here

Wanna see the new features added in the most recent update? Click here

How to download

Latest builds for the engine can be found in the Actions tab.
In the future (when the engine won't be a WIP anymore) we're gonna also publish the engine on platforms like Gamebanana; stay tuned!

How to build

 > **Open the instructions for your platform**
Windows ##### Tested on Windows 10 21H2 1. Install [version 4.2.5 of Haxe](https://haxe.org/download/version/4.2.5/). 2. Download and install [`git-scm`](https://git-scm.com/download/win). - Leave all installation options as default. 3. Run `update.bat` using cmd or double-clicking it, and wait for the libraries to install. 4. Once the libraries are installed, run `haxelib run lime test windows` to compile and launch the game (may take a long time) - ℹ You can run `haxelib run lime setup` to make the lime command global, allowing you to execute `lime test windows` directly.
Linux ##### Requires testing 1. Install [version 4.2.5 of Haxe](https://haxe.org/download/version/4.2.5/). 2. Install `g++`, if not present already. 3. Download and install [`git-scm`](https://git-scm.com/download/linux). 4. Open a terminal in the Codename Engine source folder, and run `update.sh`. 5. Once the libraries are installed, run `haxelib run lime test linux` to compile and launch the game (may take a long time) - ℹ You can run `haxelib run lime setup` to make the lime command global, allowing you to execute `lime test linux` directly.
MacOS ##### Requires testing 1. Install [version 4.2.5 of Haxe](https://haxe.org/download/version/4.2.5/). 2. Install `Xcode` to allow C++ app building. 3. Download and install [`git-scm`](https://git-scm.com/download/mac). 4. Open a terminal in the Codename Engine source folder, and run `update.sh`. 5. Once the libraries are installed, run `haxelib run lime test mac` to compile and launch the game (may take a long time) - ℹ You can run `haxelib run lime setup` to make the lime command global, allowing you to execute `lime test mac` directly.

What can you do or not do

 ### You can: - 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](https://github.com/FNF-CNE-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 modpacks ### You can't: - 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 entire Codename Engine on platforms (Mods that use Codename Engine as source are fine, if it's specified even better) #### *If you need more info or feel like asking to do something which is not listed here, ask us directly on our discord (linked in the wiki)!*

Credits

 - Credits to [Ne_Eo](https://twitter.com/Ne_Eo_Twitch) and the [3D-HaxeFlixel](https://github.com/lunarcleint/3D-HaxeFlixel) repository for Away3D Flixel support - Credits to the [FlxAnimate](https://github.com/Dot-Stuff/flxanimate) team for the Animate Atlas support - Credits to Smokey555 for the backup Animate Atlas to spritesheet code - Credits to MAJigsaw77 for [hxvlc](https://github.com/MAJigsaw77/hxvlc) (video cutscene/mp4 support) and [hxdiscord_rpc](https://github.com/MAJigsaw77/hxdiscord_rpc) (discord rpc integration)