docs: Some Linux troubleshooting

docs/COMPILING.md

@@ -13,7 +13,7 @@
     - NOTE: By performing this operation, you are downloading Content which is proprietary and protected by national and international copyright and trademark laws. See [the LICENSE.md file for the Funkin.assets](https://github.com/FunkinCrew/funkin.assets/blob/main/LICENSE.md) repo for more information.
 5. Run `haxelib --global install hmm` and then `haxelib --global run hmm setup` to install hmm.json
 6. Run `hmm install` to install all haxelibs of the current branch
-7. Run `haxelib run lime setup` to set up lime
+7. Run `haxelib run lime setup` to set up Lime
 8. Perform additional platform setup
    - 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:
@@ -21,6 +21,8 @@
         - 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/)
+        - Note: Funkin's fork currently doesn't come with the necessary binaries so you'll have to rebuild Lime. See [Troubleshooting](TROUBLESHOOTING.md#lime-related-issues).
+        - One of Funkin's dependencies uses libVLC, which requires you to install some packages to be able to compile: `sudo apt install libvlc-dev libvlccore-dev libvlccore9`
     - HTML5: Compiles without any extra setup
 9. If you are targeting for native, you may need to run `lime rebuild <PLATFORM>` and `lime rebuild <PLATFORM> -debug`
 10. `lime test <PLATFORM>` to build and launch the game for your platform (for example, `lime test windows`)

docs/TROUBLESHOOTING.md

@@ -29,3 +29,22 @@
   - You did not clone the repository correctly! Copy the path to your `funkin` folder and run `cd the\path\you\copied`. Then follow the compilation guide starting from **Step 4**.
 
 - Other compilation issues may be caused by installing bad library versions. Try deleting the `.haxelib` folder and following the guide starting from **Step 5**.
+
+## Lime Related Issues
+- Segmentation fault and/or crash after `source/funkin/Conductor.hx:538: Done mapping time changes: [SongTimeChange(0ms,102bpm)]` line appears
+  - Caused by using official Lime instead of Funkin's fork. Reinstalling Lime should fix it.
+    - NOTE: Make sure you do this via `hmm` (e.g `hmm reinstall -f lime`) to guarantee you get Funkin's version of Lime.
+
+- `Uncaught exception - Could not find lime.ndll. This file is provided with Lime's Haxelib releases, but not via Git. Please copy it from Lime's latest Haxelib release into either .haxelib/lime/git/ndll/<PLATORM> or .haxelib/lime/git/ndll/<PLATFORM64>, as appropriate for your system. Advanced users may run "lime rebuild cpp" instead.`
+  - Usually specific to Linux. Running the commands below should fix it.
+      ```
+      cd .haxelib/lime/git
+      git submodule init
+      git submodule sync
+      git submodule update
+      cd ../../..
+      # Note: The packages here might have different names depending on your distro
+      sudo apt install libgl1-mesa-dev libglu1-mesa-dev g++ g++-multilib gcc-multilib libasound2-dev libx11-dev libxext-dev libxi-dev libxrandr-dev libxinerama-dev libpulse-dev
+      lime rebuild cpp -64 -release -clean
+      ```
+  - For other platforms you can download pre-built binaries from [Funkin's Lime](https://github.com/FunkinCrew/lime/tree/dev-funkin/ndll).