From d595767e590f5c498d10c5eddf7999723d775ed2 Mon Sep 17 00:00:00 2001 From: Cameron Taylor Date: Sat, 10 Feb 2024 13:06:27 -0500 Subject: [PATCH 1/2] small compiling guide --- README.md | 2 +- docs/COMPILING.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/COMPILING.md diff --git a/README.md b/README.md index 8f919d231..39c098af5 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This game was made with love to Newgrounds and it's community. Extra love to Tom **PLEASE USE THE LINKS ABOVE IF YOU JUST WANT TO PLAY THE GAME** -To learn how to install the necessary dependencies and compile the game from source, please check out our [building the game]() guide. +To learn how to install the necessary dependencies and compile the game from source, please check out our [building the game](/docs/compiling.md) guide. # Contributing diff --git a/docs/COMPILING.md b/docs/COMPILING.md new file mode 100644 index 000000000..f1dd8fe13 --- /dev/null +++ b/docs/COMPILING.md @@ -0,0 +1,16 @@ +# Compiling Friday Night Funkin' + +0. Setup + a. Download Haxe from [Haxe.org](https://haxe.org) +1. Cloning the Repository: Make sure when you clone, you clone the submodules to get the assets repo: + - `git clone --recurse-submodules https://github.com/FunkinCrew/funkin-secret.git` + - If you accidentally cloned without the `assets` submodule (aka didn't follow the step above), you can run `git submodule update --init --recursive` to get the assets in a foolproof way. +2. Install `hmm` (run `haxelib --global install hmm` and then `haxelib --global run hmm setup`) +3. Install all haxelibs of the current branch by running `hmm install` +4. Platform setup + - Windows: [`lime setup windows` Documentation](https://lime.openfl.org/docs/advanced-setup/windows/) + - Mac: [`lime setup mac` Documentation](https://lime.openfl.org/docs/advanced-setup/macos/) + - Linux: [`lime setup linux` Documentation](https://lime.openfl.org/docs/advanced-setup/linux/) + - HTML5: Compiles without any extra setup +5. If you are targeting for native, you likely need to run `lime rebuild PLATFORM` and `lime rebuild PLATFORM -debug` +6. `lime test PLATFORM` ! From 75faf2289010a444808a427ff201c8c0d94f1ec5 Mon Sep 17 00:00:00 2001 From: Eric Date: Sun, 11 Feb 2024 11:01:33 -0500 Subject: [PATCH 2/2] Made the Windows documentation more clear. --- docs/COMPILING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/COMPILING.md b/docs/COMPILING.md index f1dd8fe13..7f9c0cdb8 100644 --- a/docs/COMPILING.md +++ b/docs/COMPILING.md @@ -1,14 +1,17 @@ # Compiling Friday Night Funkin' 0. Setup - a. Download Haxe from [Haxe.org](https://haxe.org) + - Download Haxe from [Haxe.org](https://haxe.org) 1. Cloning the Repository: Make sure when you clone, you clone the submodules to get the assets repo: - `git clone --recurse-submodules https://github.com/FunkinCrew/funkin-secret.git` - If you accidentally cloned without the `assets` submodule (aka didn't follow the step above), you can run `git submodule update --init --recursive` to get the assets in a foolproof way. 2. Install `hmm` (run `haxelib --global install hmm` and then `haxelib --global run hmm setup`) 3. Install all haxelibs of the current branch by running `hmm install` 4. Platform setup - - Windows: [`lime setup windows` Documentation](https://lime.openfl.org/docs/advanced-setup/windows/) + - For Windows, download the [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe) + - When prompted, select "Individual Components" and make sure to download the following: + - MSVC v143 VS 2022 C++ x64/x86 build tools + - Windows 10/11 SDK - Mac: [`lime setup mac` Documentation](https://lime.openfl.org/docs/advanced-setup/macos/) - Linux: [`lime setup linux` Documentation](https://lime.openfl.org/docs/advanced-setup/linux/) - HTML5: Compiles without any extra setup