parent
d2c30e95ed
commit
1b2401adfb
16
README.md
16
README.md
|
@ -6,7 +6,7 @@ Play the Ludum Dare prototype here: https://ninja-muffin24.itch.io/friday-night-
|
||||||
Play the Newgrounds one here: https://www.newgrounds.com/portal/view/770371
|
Play the Newgrounds one here: https://www.newgrounds.com/portal/view/770371
|
||||||
Support the project on the itch.io page: https://ninja-muffin24.itch.io/funkin
|
Support the project on the itch.io page: https://ninja-muffin24.itch.io/funkin
|
||||||
|
|
||||||
IF YOU MAKE A MOD AND DISTRIBUTE A MODIFIED / RECOMIPLED VERSION, YOU MUST OPEN SOURCE YOUR MOD AS WELL
|
IF YOU MAKE A MOD AND DISTRIBUTE A MODIFIED / RECOMPILED VERSION, YOU MUST OPEN SOURCE YOUR MOD AS WELL
|
||||||
|
|
||||||
## Credits / shoutouts
|
## Credits / shoutouts
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ IF YOU MAKE A MOD AND DISTRIBUTE A MODIFIED / RECOMIPLED VERSION, YOU MUST OPEN
|
||||||
- [PhantomArcade3K](https://twitter.com/phantomarcade3k) and [Evilsk8r](https://twitter.com/evilsk8r) - Art
|
- [PhantomArcade3K](https://twitter.com/phantomarcade3k) and [Evilsk8r](https://twitter.com/evilsk8r) - Art
|
||||||
- [Kawaisprite](https://twitter.com/kawaisprite) - Musician
|
- [Kawaisprite](https://twitter.com/kawaisprite) - Musician
|
||||||
|
|
||||||
This game was made with love to Newgrounds and it's community. Extra love to Tom Fulp.
|
This game was made with love to Newgrounds and its community. Extra love to Tom Fulp.
|
||||||
|
|
||||||
## Build instructions
|
## Build instructions
|
||||||
|
|
||||||
|
@ -28,11 +28,11 @@ IF YOU WANT TO COMPILE THE GAME YOURSELF, CONTINUE READING!!!
|
||||||
|
|
||||||
### Installing the Required Programs
|
### Installing the Required Programs
|
||||||
|
|
||||||
First you need to install Haxe and HaxeFlixel. I'm too lazy to write and keep updated with that setup (which is pretty simple).
|
First, you need to install Haxe and HaxeFlixel. I'm too lazy to write and keep updated with that setup (which is pretty simple).
|
||||||
1. [Install Haxe 4.1.5](https://haxe.org/download/version/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...)
|
1. [Install Haxe 4.1.5](https://haxe.org/download/version/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](https://haxeflixel.com/documentation/install-haxeflixel/) after downloading Haxe
|
2. [Install HaxeFlixel](https://haxeflixel.com/documentation/install-haxeflixel/) after downloading Haxe
|
||||||
|
|
||||||
Other installations you'd need is the additional libraries, a fully updated list will be in `Project.xml` in the project root. Currently, these are all of the things you need to install:
|
Other installations you'd need are the additional libraries, a fully updated list will be in `Project.xml` in the project root. Currently, these are all of the things you need to install:
|
||||||
```
|
```
|
||||||
flixel
|
flixel
|
||||||
flixel-addons
|
flixel-addons
|
||||||
|
@ -50,15 +50,15 @@ You'll also need to install a couple things that involve Gits. To do this, you n
|
||||||
|
|
||||||
You should have everything ready for compiling the game! Follow the guide below to continue!
|
You should have everything ready for compiling the game! Follow the guide below to continue!
|
||||||
|
|
||||||
At the moment, you can optionally fix the transition bug in songs with zoomed out cameras.
|
At the moment, you can optionally fix the transition bug in songs with zoomed-out cameras.
|
||||||
- Run `haxelib git flixel-addons https://github.com/HaxeFlixel/flixel-addons` in the terminal/command-prompt.
|
- Run `haxelib git flixel-addons https://github.com/HaxeFlixel/flixel-addons` in the terminal/command-prompt.
|
||||||
|
|
||||||
### Ignored files
|
### Ignored files
|
||||||
|
|
||||||
I gitignore the API keys for the game, so that no one can nab them and post fake highscores on the leaderboards. But because of that the game
|
I gitignore the API keys for the game so that no one can nab them and post fake high scores on the leaderboards. But because of that the game
|
||||||
doesn't compile without it.
|
doesn't compile without it.
|
||||||
|
|
||||||
Just make a file in `/source` and call it `APIStuff.hx`, and copy paste this into it
|
Just make a file in `/source` and call it `APIStuff.hx`, and copy-paste this into it
|
||||||
|
|
||||||
```haxe
|
```haxe
|
||||||
package;
|
package;
|
||||||
|
@ -92,7 +92,7 @@ To run it from your desktop (Windows, Mac, Linux) it can be a bit more involved.
|
||||||
* MSVC v141 - VS 2017 C++ x64/x86 build tools
|
* MSVC v141 - VS 2017 C++ x64/x86 build tools
|
||||||
* MSVC v140 - VS 2015 C++ build tools (v14.00)
|
* MSVC v140 - VS 2015 C++ build tools (v14.00)
|
||||||
|
|
||||||
This will install about 22GB of crap, but once that is done you can open up a command line in the project's directory and run `lime test windows -debug`. Once that command finishes (it takes forever even on a higher end PC), you can run FNF from the .exe file under export\release\windows\bin
|
This will install about 22GB of crap, but once that is done you can open up a command line in the project's directory and run `lime test windows -debug`. Once that command finishes (it takes forever even on a higher-end PC), you can run FNF from the .exe file under export\release\windows\bin
|
||||||
As for Mac, 'lime test mac -debug' should work, if not the internet surely has a guide on how to compile Haxe stuff for Mac.
|
As for Mac, 'lime test mac -debug' should work, if not the internet surely has a guide on how to compile Haxe stuff for Mac.
|
||||||
|
|
||||||
### Additional guides
|
### Additional guides
|
||||||
|
|
Loading…
Reference in New Issue