FNF-CNE-Devs · doggogit · Apr 13, 2024 · Apr 13, 2024 · May 31, 2024 · May 31, 2024
diff --git a/BETAMESSAGE.md b/BETAMESSAGE.md
diff --git a/README.md b/README.md
@@ -1,84 +1,21 @@
 # Friday Night Funkin' - Codename Engine (WIP)
+Codename Engine is a new Friday Night Funkin' Engine aimed at simplifying modding, along with extensiblity and ease of use.<br>
+Make sure to read the wiki and join the Discord server linked there!
+
+- It includes many new features, as seen [here](other/FEATURES.md)<br>
+- Wanna see the new features added in the most recent update? Click [here](other/PATCHNOTES.md)<br>
+- Build instructions can be found [here](other/BUILDING.md).
+	- Running the command `.\cne test` within the root directory uses the source assets folder instead of the export one for easier development (Although you can still use `lime test windows` normally).
 
 ## PLEASE NOTE - THIS IS STILL IN A BETA STATE
 ### Mods created with beta versions of Codename may not be compatible with the release version
 Known issues in the beta:
 - Some options are missing
 
-Build instructions are below. Press TAB on the main menu to switch mods.
-
-Also, the command `.\cne test` uses the source assets folder instead of the export one for easier development (Although you can still use `lime test windows` normally).
-
-## Codename Engine
-
-Codename Engine is a new Friday Night Funkin' Engine aimed at simplifying modding, along with extensiblity and ease of use.<br>
-Make sure to read the wiki and join the Discord server linked there!<br>
-#### It includes many new features, as seen [here](FEATURES.md)<br>
-#### Wanna see the new features added in the most recent update? Click [here](PATCHNOTES.md)<br>
-
 ## How to download
-
 Latest builds for the engine can be found in the [Actions](https://github.com/YoshiCrafter29/CodenameEngine/actions) tab.<br>
 In the future (when the engine won't be a WIP anymore) we're gonna also publish the engine on platforms like Gamebanana; stay tuned!
 
-<details>
-  <summary><h2>How to build</h2></summary>
-
-> **Open the instructions for your platform**
-<details>
-    <summary>Windows</summary>
-
-##### Tested on Windows 10 21H2
-1. Install [version 4.2.5 of Haxe](https://haxe.org/download/version/4.2.5/).
-2. Download and install [`git-scm`](https://git-scm.com/download/win).
-    - Leave all installation options as default.
-3. Run `update.bat` using cmd or double-clicking it, and wait for the libraries to install.
-4. Once the libraries are installed, run `haxelib run lime test windows` to compile and launch the game (may take a long time)
-    - ℹ You can run `haxelib run lime setup` to make the lime command global, allowing you to execute `lime test windows` directly.
-</details>
-<details>
-    <summary>Linux</summary>
-
-##### Requires testing
-1. Install [version 4.2.5 of Haxe](https://haxe.org/download/version/4.2.5/).
-2. Install `g++`, if not present already.
-3. Download and install [`git-scm`](https://git-scm.com/download/linux).
-4. Open a terminal in the Codename Engine source folder, and run `update.sh`.
-5. Once the libraries are installed, run `haxelib run lime test linux` to compile and launch the game (may take a long time)
-    - ℹ You can run `haxelib run lime setup` to make the lime command global, allowing you to execute `lime test linux` directly.
-</details>
-<details>
-    <summary>MacOS</summary>
-
-##### Requires testing
-1. Install [version 4.2.5 of Haxe](https://haxe.org/download/version/4.2.5/).
-2. Install `Xcode` to allow C++ app building.
-3. Download and install [`git-scm`](https://git-scm.com/download/mac).
-4. Open a terminal in the Codename Engine source folder, and run `update.sh`.
-5. Once the libraries are installed, run `haxelib run lime test mac` to compile and launch the game (may take a long time)
-    - ℹ You can run `haxelib run lime setup` to make the lime command global, allowing you to execute `lime test mac` directly.
-</details>
-</details>
-
-<details>
-  <summary><h2>What can you do or not do</h2></summary>
-
-  ### You can:
-  - Download and play the engine with its mods and modpacks
-  - Mod and fork the engine (without using it for illicit purposes)
-  - Contribute to the engine (for example through *Pull Requests*, *Issues*, etc)
-  - Create a sub engine with Codename Engine as **TEMPLATE** with **CREDITS** (for example leaving the *credits menu submenu with the GitHub contributors* and putting the *[main devs](https://github.com/FNF-CNE-Devs)* in a *README* specifying that it's a *sub engine from Codename Engine*)
-  - Release excutable mods that use Codename Engine as source (Specifing that uses Codename Engine by for example the same way written above this)
-  - Release modpacks
-
-  ### You can't:
-  - Create a *side/new/etc* engine (or mod that doesn't use Codename Engine) using Codename Engine's code
-  - Steal code from Codename Engine for another different project that is not Codename Engine related (Codename Engine mods excluded) without properly crediting
-  - Release the entire Codename Engine on platforms (Mods that use Codename Engine as source are fine, if it's specified even better)
-
-  #### *If you need more info or feel like asking to do something which is not listed here, ask us directly on our discord (linked in the wiki)!*
-</details>
-
 <details>
   <summary><h2>Credits</h2></summary>
 

diff --git a/art/FMOD Logo Black - White Background.png b/art/FMOD Logo Black - White Background.png
diff --git a/art/FMOD Logo White - Black Background.png b/art/FMOD Logo White - Black Background.png
diff --git a/art/Funkin.bmp b/art/Funkin.bmp
diff --git a/art/FunkinAlt.bmp b/art/FunkinAlt.bmp
diff --git a/art/bald.gif b/art/bald.gif
diff --git a/art/burns.png b/art/burns.png
diff --git a/art/c_z.mp3 b/art/c_z.mp3
diff --git a/art/concept.pfi → art/design ideas/concept.pfi b/art/concept.pfi → art/design ideas/concept.pfi
diff --git a/art/flashFiles/BF_death_pixels.fla b/art/flashFiles/BF_death_pixels.fla
diff --git a/art/flashFiles/BoyFriend_Assets.fla b/art/flashFiles/BoyFriend_Assets.fla
diff --git a/art/flashFiles/BoyFriend_Assets_CHRISTMAS_VARIANT.fla b/art/flashFiles/BoyFriend_Assets_CHRISTMAS_VARIANT.fla
diff --git a/art/flashFiles/BoyFriend_Assets_PIXEL_VARIANT.fla b/art/flashFiles/BoyFriend_Assets_PIXEL_VARIANT.fla
diff --git a/art/flashFiles/BoyFriend_HAIR_BLOWING_Assets.fla b/art/flashFiles/BoyFriend_HAIR_BLOWING_Assets.fla
diff --git a/art/flashFiles/Christmas_Background_Assets.fla b/art/flashFiles/Christmas_Background_Assets.fla
diff --git a/art/flashFiles/Dad_assets.fla b/art/flashFiles/Dad_assets.fla
diff --git a/art/flashFiles/EVIL_Christmas_BG.fla b/art/flashFiles/EVIL_Christmas_BG.fla
diff --git a/art/flashFiles/Effects_Assets.fla b/art/flashFiles/Effects_Assets.fla
diff --git a/art/flashFiles/FNF_main_menu_assets.fla b/art/flashFiles/FNF_main_menu_assets.fla
diff --git a/art/flashFiles/GF_PIXEL_VARIANT.fla b/art/flashFiles/GF_PIXEL_VARIANT.fla
diff --git a/art/flashFiles/GF_ass_sets_CHRISTMAS_VARIANT.fla b/art/flashFiles/GF_ass_sets_CHRISTMAS_VARIANT.fla
diff --git a/art/flashFiles/GF_assets.fla b/art/flashFiles/GF_assets.fla
diff --git a/art/flashFiles/MOM_BG_asset_pack.fla b/art/flashFiles/MOM_BG_asset_pack.fla
diff --git a/art/flashFiles/Mom_Assets.fla b/art/flashFiles/Mom_Assets.fla
diff --git a/art/flashFiles/Mom_HAIR_BLOWING_Assets.fla b/art/flashFiles/Mom_HAIR_BLOWING_Assets.fla
diff --git a/art/flashFiles/Monster_Assets.fla b/art/flashFiles/Monster_Assets.fla
diff --git a/art/flashFiles/Monster_Assets_Christmas.fla b/art/flashFiles/Monster_Assets_Christmas.fla
diff --git a/art/flashFiles/Pico_BG_train_assets.fla b/art/flashFiles/Pico_BG_train_assets.fla
diff --git a/art/flashFiles/Pico_FNF_assetss.fla b/art/flashFiles/Pico_FNF_assetss.fla
diff --git a/art/flashFiles/Pixel_BG_Girls.fla b/art/flashFiles/Pixel_BG_Girls.fla
diff --git a/art/flashFiles/Senpai_Assets.fla b/art/flashFiles/Senpai_Assets.fla
diff --git a/art/flashFiles/Start_Screen_Assets.fla b/art/flashFiles/Start_Screen_Assets.fla
diff --git a/art/flashFiles/Text_Boxes.fla b/art/flashFiles/Text_Boxes.fla
diff --git a/art/flashFiles/UI_assets.fla b/art/flashFiles/UI_assets.fla
diff --git a/art/flashFiles/Week_6_BG_2.fla b/art/flashFiles/Week_6_BG_2.fla
diff --git a/art/flashFiles/campaign_menu_UI_assets.fla b/art/flashFiles/campaign_menu_UI_assets.fla
diff --git a/art/flashFiles/funkinpause.fla b/art/flashFiles/funkinpause.fla
diff --git a/art/flashFiles/funkinpauseyellow.fla b/art/flashFiles/funkinpauseyellow.fla
diff --git a/art/flashFiles/halloween_bg.fla b/art/flashFiles/halloween_bg.fla
diff --git a/art/flashFiles/mom_dad_christmas_assets.fla b/art/flashFiles/mom_dad_christmas_assets.fla
diff --git a/art/flashFiles/petals_animation.fla b/art/flashFiles/petals_animation.fla
diff --git a/art/flashFiles/spooky_kids_assets.fla b/art/flashFiles/spooky_kids_assets.fla
diff --git a/art/github/windows-installation-details.png b/art/github/windows-installation-details.png
diff --git a/art/preloaderArt.png b/art/preloaderArt.png
diff --git a/art/teaser layers/teaser bg.png → art/teaser/layers/teaser bg.png b/art/teaser layers/teaser bg.png → art/teaser/layers/teaser bg.png
diff --git a/art/teaser layers/teaser checkerboard.png → art/teaser/layers/teaser checkerboard.png b/art/teaser layers/teaser checkerboard.png → art/teaser/layers/teaser checkerboard.png
diff --git a/art/teaser layers/teaser funkin logo.png → art/teaser/layers/teaser funkin logo.png b/art/teaser layers/teaser funkin logo.png → art/teaser/layers/teaser funkin logo.png
diff --git a/art/teaser layers/teaser question mark.png → art/teaser/layers/teaser question mark.png b/art/teaser layers/teaser question mark.png → art/teaser/layers/teaser question mark.png
diff --git a/art/teaser discord.png → art/teaser/teaser discord.png b/art/teaser discord.png → art/teaser/teaser discord.png
diff --git a/art/teaser.png → art/teaser/teaser.png b/art/teaser.png → art/teaser/teaser.png
diff --git a/art/thumbnailNewer.png b/art/thumbnailNewer.png
diff --git a/art/veryimportant.png b/art/veryimportant.png
diff --git a/commandline/commands/Update.hx b/commandline/commands/Update.hx
@@ -15,7 +15,7 @@ class Update {
 			FileSystem.createDirectory('.haxelib');
 
 		var libs:Array<Library> = [];
-		var libsXML:Access = new Access(Xml.parse(File.getContent('./libs.xml')).firstElement());
+		var libsXML:Access = new Access(Xml.parse(File.getContent('commandline/libs.xml')).firstElement());
 
 		for (libNode in libsXML.elements) {
 			var lib:Library = {

diff --git a/libs.xml → commandline/libs.xml b/libs.xml → commandline/libs.xml
diff --git a/art/generateDoc.bat → docs/generateDoc.bat b/art/generateDoc.bat → docs/generateDoc.bat
diff --git a/other/BUILDING.md b/other/BUILDING.md
@@ -0,0 +1,40 @@
+# BUILDING
+
+<details>
+  <summary><h2>How to build</h2></summary>
+
+> **Open the instructions for your platform**
+<details>
+    <summary>Windows</summary>
+
+##### Tested on Windows 10 21H2
+1. Install [version 4.2.5 of Haxe](https://haxe.org/download/version/4.2.5/).
+2. Download and install [`git-scm`](https://git-scm.com/download/win).
+    - Leave all installation options as default.
+3. Run `update.bat`, located in `shell-scripts/update` using cmd or double-clicking it, and wait for the libraries to install.
+4. Once the libraries are installed, run `haxelib run lime test windows` to compile and launch the game (may take a long time)
+    - ℹ You can run `haxelib run lime setup` to make the lime command global, allowing you to execute `lime test windows` directly.
+</details>
+<details>
+    <summary>Linux</summary>
+
+##### Requires testing
+1. Install [version 4.2.5 of Haxe](https://haxe.org/download/version/4.2.5/).
+2. Install `g++`, if not present already.
+3. Download and install [`git-scm`](https://git-scm.com/download/linux).
+4. Open a terminal in the Codename Engine source folder, navigate to `shell-scripts/update` and run `update.sh`.
+5. Once the libraries are installed, run `haxelib run lime test linux` to compile and launch the game (may take a long time)
+    - ℹ You can run `haxelib run lime setup` to make the lime command global, allowing you to execute `lime test linux` directly.
+</details>
+<details>
+    <summary>MacOS</summary>
+
+##### Requires testing
+1. Install [version 4.2.5 of Haxe](https://haxe.org/download/version/4.2.5/).
+2. Install `Xcode` to allow C++ app building.
+3. Download and install [`git-scm`](https://git-scm.com/download/mac).
+4. Open a terminal in the Codename Engine source folder, navigate to `shell-scripts/update` and run `update.sh`.
+5. Once the libraries are installed, run `haxelib run lime test mac` to compile and launch the game (may take a long time)
+    - ℹ You can run `haxelib run lime setup` to make the lime command global, allowing you to execute `lime test mac` directly.
+</details>
+</details>
diff --git a/FEATURES.md → other/FEATURES.md b/FEATURES.md → other/FEATURES.md
@@ -79,4 +79,23 @@ _**QOL = Quality of Life**_
 		- Features not found in other editors!
     - Every single state & substate can be modified via HScript (`data/states/StateName.hx`)
 - **Instances launched via `lime test windows` will automatically use assets from source.**
+</details>
+
+<details>
+  <summary><h2>What can you do or not do</h2></summary>
+
+  ### You can:
+  - Download and play the engine with its mods and modpacks
+  - Mod and fork the engine (without using it for illicit purposes)
+  - Contribute to the engine (for example through *Pull Requests*, *Issues*, etc)
+  - Create a sub engine with Codename Engine as **TEMPLATE** with **CREDITS** (for example leaving the *credits menu submenu with the GitHub contributors* and putting the *[main devs](https://github.com/FNF-CNE-Devs)* in a *README* specifying that it's a *sub engine from Codename Engine*)
+  - Release excutable mods that use Codename Engine as source (Specifing that uses Codename Engine by for example the same way written above this)
+  - Release modpacks
+
+  ### You can't:
+  - Create a *side/new/etc* engine (or mod that doesn't use Codename Engine) using Codename Engine's code
+  - Steal code from Codename Engine for another different project that is not Codename Engine related (Codename Engine mods excluded) without properly crediting
+  - Release the entire Codename Engine on platforms (Mods that use Codename Engine as source are fine, if it's specified even better)
+
+  #### *If you need more info or feel like asking to do something which is not listed here, ask us directly on our discord (linked in the wiki)!*
 </details>
diff --git a/PATCHNOTES.md → other/PATCHNOTES.md b/PATCHNOTES.md → other/PATCHNOTES.md
diff --git a/art/SECRET REPO INSTRUCTIONS.md → other/SECRET REPO INSTRUCTIONS.md b/art/SECRET REPO INSTRUCTIONS.md → other/SECRET REPO INSTRUCTIONS.md