Skip to content

Commit b5ac5ca

Browse files
author
Lily
authored
Update README.md
1 parent 537ac53 commit b5ac5ca

File tree

1 file changed

+5
-46
lines changed

1 file changed

+5
-46
lines changed

README.md

Lines changed: 5 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,19 @@
1-
# Friday Night Funkin': CDEV Engine
1+
# Friday Night Funkin': CDEV Engine Mobile
22
![logo](art/CDEV-Engine-Logo.png)
33

44
FNF CDEV Engine is a Friday Night Funkin' Engine that's intended to fix issues with the base game, while also adding a lot of features to the engine.
55

6-
## Build instructions
7-
8-
First you need to install Haxe and HaxeFlixel.
9-
1. [Install Haxe 4.2.5](https://haxe.org/download/version/4.2.5/) (If you're using newer version of haxe, CDEV Engine would likely failed to compile due to macro stuffs)
10-
2. [Install HaxeFlixel](https://haxeflixel.com/documentation/install-haxeflixel/) after downloading Haxe.
11-
12-
Second, you need to install the additional libraries, a fully updated list will be in `Project.xml` in the project root. Here's the list of libraries that you need to install:
13-
```
14-
flixel
15-
flixel-addons
16-
flixel-ui
17-
hscript
18-
hxCodec
19-
extension-androidtools
20-
HxWebView
21-
```
22-
Type `haxelib install [library]` for each the libraries, so like: `haxelib install newgrounds`.
23-
24-
There are also few libraries that you need to install using git.
25-
1. Download [git-scm](https://git-scm.com/downloads). Works for Windows, Mac, and Linux, just select your build.
26-
2. Follow instructions to install the application properly.
27-
3. Run `haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc` to install the library.
28-
4. run `haxelib git flxanimate https://github.com/Core5570RYT/flxanimate-cdev.git` to install CDEV Engine version of FlxAnimate.
29-
30-
You should have everything ready for compiling the engine! Follow the guide below to continue!
31-
32-
### Compiling the engine
33-
34-
> For now, CDEV Engine supports compiling only to Windows.
35-
36-
To compile the engine to Windows Target, you need to install Visual Studio Community. While installing VSC, don't click on any of the options to install workloads. Instead, go to the "Individual Components" tab and choose the following:
37-
* MSVC v143 - VS 2019 C++ x64/x86 build tools
38-
* Windows SDK (10.0.17763.0)
39-
40-
Once you have finished doing all of those steps, you could run this command to build the engine.
41-
> `lime test windows` or `lime test windows -debug` to run the game with debugging enabled.
42-
43-
Your compiled version of CDEV Engine are located under the `export` folder in the root of your project.
44-
45-
Now you know how to build the engine, enjoy!
46-
476
## CDEV Engine Modding Docs
487
If you don't like modifying source codes, you might want to try the built-in modding feature, though you also need to read this page to understand how modding works in this engine:
498
> https://core5570ryt.github.io/FNF-CDEV-Engine/
509
5110
## Source Code Modding!!
52-
If you wanted to make mods without using the built-in modding support, Download the source code from the Releases tab or press [Here](https://github.com/Core5570RYT/FNF-CDEV-Engine/releases/latest)
53-
54-
## Supported Platforms
55-
CDEV Engine is currently only supported for Windows target only (I don't understand how to do cross-platform support)
11+
If you wanted to make mods without using the built-in modding support, Download the source code from the Releases tab or press [Here](https://github.com/MobilePorting/FNF-CDEV-Engine-Mobile/releases/latest)
5612

5713
# Credits
14+
Mobile Port
15+
- [Lily](https://www.youtube.com/@mcagabe19) - Everything.
16+
5817
CDEV Engine
5918
- [CoreDev](https://twitter.com/core5570r) - Programmer of this engine, additional assets.
6019

0 commit comments

Comments
 (0)