diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index cc4d5b11a..efa81b56d 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -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 diff --git a/.github/ISSUE_TEMPLATE/compiling.md b/.github/ISSUE_TEMPLATE/compiling.md new file mode 100644 index 000000000..14aea44a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/compiling.md @@ -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. + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 0adb3cc26..a257c217a 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -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? diff --git a/README.md b/README.md index 1c96e4979..e434e1d52 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ 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 / RECOMIPLED VERSION, YOU MUST OPEN SOURCE YOUR MOD AS WELL + ## Credits / shoutouts - [ninjamuffin99 (me!)](https://twitter.com/ninja_muffin99) - Programmer @@ -76,22 +78,11 @@ and you should be good to go there. 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: +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 diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 000000000..aba261b5f --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,7 @@ +this is for funkin website stuff +if you're compiling game, you can ignore this folder completely! + +if not, dawg check out [funkin.me](https://funkin.me) + +note that i probably won't accept any major pull requests for this +cuz I wanna make the website as a nice lil project to teach myself HTML and CSS and all that!!