diff --git a/docs/INSTALLING_MODS.md b/docs/INSTALLING_MODS.md new file mode 100644 index 000000000..9306ee438 --- /dev/null +++ b/docs/INSTALLING_MODS.md @@ -0,0 +1,32 @@ +# HTML5/Web +1. Nope + +# Windows +1. Start the game at least once. This will create a `mods` folder if it doesn't already exist, alongside the executable. +2. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder. +3. Restart the game. The game should detect the mod and start with it. + +# Linux +1. Start the game at least once. This will create a `mods` folder if it doesn't already exist, alongside the executable. +2. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder. +3. Restart the game. The game should detect the mod and start with it. + +# MacOS +1. Start the game at least once. This will create a `mods` folder if it doesn't already exist in the game's system files. +2. Right click `Funkin.app` and select `Show Package Contents`. +3. Navigate to `Contents/Resources/mods`. +4. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder. +5. Restart the game. The game should detect the mod and start with it. + +# Android +1. Start the game at least once. This will create a `mods` folder deep in your system files. +2. Get an Android file browser that lets you view the app data files, or use Android Studio and open up the Device Explorer. +3. Locate the `/sdcard/Android/obb/me.funkin.fnf/mods` folder. +4. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder. +5. Restart the game (you may have to [force close](https://support.google.com/android/answer/9079646?hl=en) the app first). The game should detect the mod and start with it. + +# iOS +1. Start the game at least once. This will create a `mods` folder in your system files. +2. Open the Files app, and navigate to `On My iPhone` -> `Friday Night Funkin` -> `mods`. +3. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder. +4. Restart the game (you may have to [force close](https://support.apple.com/en-us/109359) the app first). The game should detect the mod and start with it.