THIS PROJECT IS OVER?

No. This project is now gonna be bugfixed, whilest adding some features.

Now you might be saying, "Why haya? Why?".

For the longest time I've neglected this pet project of mine and considered it cancelled. But today's the day that changes.

Welcome, to hell's first layer.

Original game

Play the Newgrounds one here!

Play the Ludum Dare prototype here!

Support the project on the Itch.io page!

Mod

You need to compile the game, info below.

Credits / Shoutouts (for the original game)

Programmers:

💻 ninjamuffin99

Artists:

🎨 PhantomArcade3K

🎨 Evilsk8r

Musicians:

🎶 Kawaisprite

Credits / Shoutouts (for the mod)

Programmers:

💻 haya (me!)

💻 KadeDev

💻 FriedFrick

💻 Smokey

Artists:

🎨 FriedFrick

🎨 Keaton Hoshida

Special Thanks 💖

This game was made with love to Newgrounds and its community. Extra love to Tom Fulp. 💖

What can I do with compiling the game? Why should I compile the game instead of downloading it from the Itch.io page of the game?

Compiling the game gives access to the /source folder, allowing you to change the code of the game. You can add a lot of cool things with the open source code!

I recommend having a good idea on how to program. Compiling the game is not for everyone!

If you just want to download and play the game normally, you can click here to go to the Itch.io page of the game!

If you do want to compile, continue reading!

Installing the Required Programs

First you need to install Haxe and HaxeFlixel.

1. Install Haxe 4.1.5 (Download 4.1.5 instead of 4.2.0 because 4.2.0 is broken and is not working with gits properly...)
2. Install HaxeFlixel after downloading Haxe

Other installations you will need are the additional libraries. A fully updated list will be in Project.xml in the project root. Currently, these are all the things you need to install:

flixel
flixel-addons
flixel-ui
hscript
newgrounds

So, for each of those type haxelib install [library] so shit like haxelib install newgrounds.

You will also need to install a couple things that involve Gits. To do this, you need to do a few things first.

1. Download git-scm. Works for Windows, Mac, and Linux, just select your build.
2. Follow instructions to install the application properly.
3. Run haxelib git polymod https://github.com/larsiusprime/polymod.git to install Polymod.
4. Run haxelib git discord_rpc https://github.com/Aidan63/linc_discord-rpc to install Discord RPC.
5. Run haxelib install linc_luajit to install lua library. (will be used later)
6. Optional: - Run haxelib git flixel-addons https://github.com/HaxeFlixel/flixel-addons to update Flixel-Addons. This fixes the transition bug for zoomed out stage cameras.

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

Adding APIStuff.hx into /source

The API keys of the game were gitignored so no one could post fake high scores onto the leaderboards in Newgrounds. Unfortunately, because this game requires the API and EncKey values to compile, you will need to add a file called APIStuff.hx into /source.

1. Create a new text file called APIStuff.hx inside of the /source folder.
2. Copy the following text:

package;
class APIStuff
{
	public static var API:String = "";
	public static var EncKey:String = "";
}

3. Paste the text into the APIStuff.hx file and save the file.

You should be good from there! Now, onto compiling!

Compiling the Game

HTML Building:

Compiling the game is rather simple for HTML5 builds.

1. Open your machine's command prompt/terminal and navigate to your root folder of the game. An easy guide can be found here!
2. Type lime build html5 -debug to build the HTML5 version of the game.
3. Type lime run html5 -debug to run the HTML5 version of the game from the command prompt/terminal. (You can also run the game from funkin/export/debug/html5/bin)

You should be all good to play the HTML5 version of the game!

Desktop Building:

Desktop building can be a bit tedious. Each different version requires a different setup.

Linux Building:

1. Open your machine's command prompt/terminal and navigate to your root folder of the game. An easy guide can be found here!
2. Type lime build linux -debug to build the Linux version of the game.
3. Type lime run linux -debug to run the Linux version of the game from the command prompt/terminal. (You can also run the game from funkin/export/debug/linux/bin)

Mac Building:

1. Open your machine's command prompt/terminal and navigate to your root folder of the game. An easy guide can be found here!
2. Type lime build mac -debug to build the Mac version of the game.
3. Type lime run mac -debug to run the Mac version of the game from the command prompt/terminal. (You can also run the game from funkin/export/debug/mac/bin)

Windows Building:

THIS METHOD REQUIRES AROUND 22 GIGABYTES OF STORAGE.

1. Install Visual Studio Community 2019.
2. Open the installer and go to the individual workloads tab and download the following:

* C++ CMake tools for windows 
* C++ Profiling tools 
* C++ ATL for v142 build tools (x86 & x64)
* C++ MFC for v142 build tools (x86 & x64)
* C++/CLI support for v142 build tools (14.21)
* C++ Modules for v142 build tools (x64/x86)
* Clang Compiler for Windows
* MSVC v140 - VS 2015 C++ build tools (v14.00) 
* MSVC v141 - VS 2017 C++ x64/x86 build tools
* MSVC v142 - VS 2019 C++ x64/x86 build tools
* Windows 10 SDK (10.0.16299.0)
* Windows 10 SDK (10.0.17134.0)
* Windows SDK (10.0.17763.0)

3. Wait for the install to finish, which might take a while.
4. Open your machine's command prompt/terminal and navigate to your root folder of the game. An easy guide can be found here!
5. Once everything is installed, type lime build windows -debug to build the windows version of the game.
6. Type lime run windows -debug after the game is compiled to run the windows version of the game. (You can also run the game from funkin/export/debug/windows/bin)

All done!

You should have been able to compile the whole game now! What can you do now? Well, you can mod to your heart's desire! Since this game is open source, the creator loves seeing what other talented artists and programmers can make! Special thanks to the amazing group of dedicated people that are making this game amazing!

💖💖