Merge branch 'master' of https://github.com/ninjamuffin99/funkin into week7
This commit is contained in:
Cameron Taylor
commit
6ab411b605
|
|
@ -1,21 +1,44 @@
|
|||
---
|
||||
name: Bug Report
|
||||
about: Report a bug or critical performance issue
|
||||
title: 'Bug Report: '
|
||||
title: 'Bug Report: [DESCRIBE YOUR BUG IN DETAIL HERE]'
|
||||
labels: bug
|
||||
---
|
||||
|
||||
[weed]: <> (FILL THIS ISSUE THING OUT AS MUCH AS POSSIBLE)
|
||||
[weed]: <> (OR ELSE YOUR ISSUE WILL BE LESS LIKELY TO BE SOLVED!)
|
||||
[weed]: <> (DO NOT POST ABOUT ISSUES FROM OTHER FNF MOD ENGINES! I CANNOT AND PROBABLY WON'T SOLVE THOSE!)
|
||||
[weed]: <> (GO TO THEIR RESPECTIVE GITHUB ISSUES AND REPORT THEM THERE LOL!)
|
||||
|
||||
[weed]: <> (ALSO MAKE SURE THAT YOU USE PROPER LABELS, IF YOU'RE RUNNING INTO COMPILER ISSUES, USE THE compiler issue LABEL!!!)
|
||||
|
||||
#### Please check for duplicates or similar issues, as well performing simple troubleshooting steps (such as clearing cookies, clearing AppData, trying another browser) before submitting an issue.
|
||||
### If you are playing the game in a browser, what site are you playing it from?
|
||||
[Newgrounds](https://www.newgrounds.com/portal/view/770371) or [Itch.io](https://ninja-muffin24.itch.io/funkin)? Specify below.
|
||||
|
||||
[weed]: <> (Put an X in the [ ] thingies to fill out checkbox!)
|
||||
[weed]: <> (something like [x] pretty much, don't screw up or you will look stupid)
|
||||
|
||||
- [ ] [Newgrounds](https://www.newgrounds.com/portal/view/770371)
|
||||
- [ ] [Itch.io](https://ninja-muffin24.itch.io/funkin)? Specify below
|
||||
- - [ ] Windows
|
||||
- - [ ] Mac
|
||||
- - [ ] Linux
|
||||
|
||||
### If you are playing the game in a browser, what browser are you using?
|
||||
Chrome (or a Chromium based browser, i.e. Edge, Opera, etc.), Firefox, or Safari? Specify blow.
|
||||
|
||||
### If you are playing a downloaded version of the game, what operating system are you using?
|
||||
Windows (`x86`), Windows (`x86_64`), Linux, or macOS? Specify below.
|
||||
[weed]: <> (Again, put an x in the [ ] box!)
|
||||
|
||||
## What version of the game are you using? Look in the bottom left corner of the main menu.
|
||||
- [ ] Google Chrome (or chomium based like Brave, vivaldi, MS Edge)
|
||||
- [ ] Firefox
|
||||
- [ ] Safari
|
||||
|
||||
## Have you identified any steps to reproduce the bug? If so, please describe them below. Use images if possible.
|
||||
## What version of the game are you using? Look in the bottom left corner of the main menu. (ex: 0.2.7, 0.2.1, shit like that)
|
||||
|
||||
|
||||
## Have you identified any steps to reproduce the bug? If so, please describe them below in as much detail as possible. Use images if possible.
|
||||
|
||||
## Please describe your issue. Provide extensive detail and images if possible.
|
||||
|
||||
|
||||
|
||||
## If you're game is FROZEN and you're playing a web version, press F12 to open up browser dev window, and go to console, and copy-paste whatever red error you're getting
|
||||
|
|
|
|||
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
name: Compiling help
|
||||
about: If you need help compiling the game, and you're running into issues. (Look through the 'compiling help' label in case it's been solved!)
|
||||
title: 'Compiling help: [BRIEF DESCRIPTION / ERROR MESSAGE OUTPUT]'
|
||||
labels: compiling help
|
||||
---
|
||||
|
||||
[weed]: <> (FILL THIS ISSUE THING OUT AS MUCH AS POSSIBLE)
|
||||
[weed]: <> (OR ELSE YOUR ISSUE WILL BE LESS LIKELY TO BE SOLVED!)
|
||||
[weed]: <> (DO NOT POST ABOUT ISSUES FROM OTHER FNF MOD ENGINES! I CANNOT AND PROBABLY WON'T SOLVE THOSE!)
|
||||
[weed]: <> (GO TO THEIR RESPECTIVE GITHUB ISSUES AND REPORT THEM THERE LOL!)
|
||||
|
||||
#### Please check for duplicates or similar compiler issues by filtering for 'compiler help'
|
||||
|
||||
[weed]: <> (Put an X in the [ ] thingies to fill out checkbox!)
|
||||
[weed]: <> (something like [x] pretty much, don't screw up or you will look stupid)
|
||||
|
||||
|
||||
- [ ] Windows
|
||||
- [ ] Mac
|
||||
- [ ] Linux
|
||||
- [ ] HTML5
|
||||
|
||||
## Please describe your issue. Provide extensive detail and images if possible.
|
||||
|
||||
|
|
@ -4,5 +4,9 @@ about: Ask a general question
|
|||
title: 'Question: '
|
||||
labels: question
|
||||
---
|
||||
|
||||
[weed]: <> (This isn't a place for AMA type questions, if you want to ask any of the devs something, reach out to them on twitter prob )
|
||||
[weed]: <> (any biz bullshit can go to cameron.taylor.ninja@gmail.com)
|
||||
|
||||
#### Please check for duplicates or similar issues before asking your question.
|
||||
## What is your question?
|
||||
|
|
|
|||
2
LICENSE
2
LICENSE
|
|
@ -1,4 +1,4 @@
|
|||
Apache License
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
|
|
|
|||
33
README.md
33
README.md
|
|
@ -6,13 +6,15 @@ 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
|
||||
Support the project on the itch.io page: https://ninja-muffin24.itch.io/funkin
|
||||
|
||||
IF YOU MAKE A MOD AND DISTRIBUTE A MODIFIED / RECOMPILED VERSION, YOU MUST OPEN SOURCE YOUR MOD AS WELL
|
||||
|
||||
## Credits / shoutouts
|
||||
|
||||
- [ninjamuffin99 (me!)](https://twitter.com/ninja_muffin99) - Programmer
|
||||
- [PhantomArcade3K](https://twitter.com/phantomarcade3k) and [Evilsk8r](https://twitter.com/evilsk8r) - Art
|
||||
- [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
|
||||
|
||||
|
|
@ -26,11 +28,11 @@ IF YOU WANT TO COMPILE THE GAME YOURSELF, CONTINUE READING!!!
|
|||
|
||||
### 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...)
|
||||
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-addons
|
||||
|
|
@ -48,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!
|
||||
|
||||
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.
|
||||
|
||||
### 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.
|
||||
|
||||
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
|
||||
package;
|
||||
|
|
@ -73,25 +75,14 @@ class APIStuff
|
|||
and you should be good to go there.
|
||||
|
||||
### Compiling game
|
||||
NOTE: If you see any messages relating to deprecated packages, ignore them. They're just warnings that don't affect compiling
|
||||
|
||||
Once you have all those installed, it's pretty easy to compile the game. You just need to run 'lime test html5 -debug' in the root of the project to build and run the HTML5 version. (command prompt navigation guide can be found here: [https://ninjamuffin99.newgrounds.com/news/post/1090480](https://ninjamuffin99.newgrounds.com/news/post/1090480))
|
||||
|
||||
To run it from your desktop (Windows, Mac, Linux) it can be a bit more involved. For Linux, you only need to open a terminal in the project directory and run 'lime test linux -debug' and then run the executible file in export/release/linux/bin. For Windows, you need to install Visual Studio Community 2019. 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:
|
||||
Once you have all those installed, it's pretty easy to compile the game. You just need to run `lime test html5 -debug` in the root of the project to build and run the HTML5 version. (command prompt navigation guide can be found here: [https://ninjamuffin99.newgrounds.com/news/post/1090480](https://ninjamuffin99.newgrounds.com/news/post/1090480))
|
||||
To run it from your desktop (Windows, Mac, Linux) it can be a bit more involved. For Linux, you only need to open a terminal in the project directory and run `lime test linux -debug` and then run the executable file in export/release/linux/bin. For Windows, you need to install Visual Studio Community 2019. 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:
|
||||
* MSVC v142 - VS 2019 C++ x64/x86 build tools
|
||||
* Windows SDK (10.0.17763.0)
|
||||
* C++ Profiling tools
|
||||
* C++ CMake tools for windows
|
||||
* 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
|
||||
* Windows 10 SDK (10.0.17134.0)
|
||||
* Windows 10 SDK (10.0.16299.0)
|
||||
* MSVC v141 - VS 2017 C++ x64/x86 build tools
|
||||
* 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
|
||||
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.
|
||||
|
||||
### Additional guides
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
You should know what this is for by the title of what it is called.
|
||||
|
|
@ -44,4 +44,5 @@ downscroll--i dont know what that is
|
|||
warning--choking hazard
|
||||
devin chat--what an honorable man
|
||||
kickstarter exclusive--intro text
|
||||
cussing--we have it
|
||||
cussing--we have it
|
||||
github exclusive intro text--open source forever
|
||||
|
|
|
|||
Loading…
Reference in New Issue