Skip to content

Commit

Permalink
Make downloading the assets submodule a separate step.
Browse files Browse the repository at this point in the history
  • Loading branch information
EliteMasterEric authored Jun 16, 2024
1 parent 504766a commit 9bd09e3
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/COMPILING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
- Download Git from [git-scm.com](https://www.git-scm.com)
- Do NOT download the repository using the Download ZIP button on GitHub or you may run into errors!
- Instead, open a command prompt and do the following steps...
1. Run `git clone --recurse-submodules https://github.com/FunkinCrew/funkin.git` to clone the repository with the necessary assets submodule
- _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._
1. Run `git clone https://github.com/FunkinCrew/funkin.git` to clone the base repository.
2. Run `git submodule update --init --recursive` to download the game's assets.
- 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.
2. Run `haxelib --global install hmm` and then `haxelib --global run hmm setup` to install hmm.json
3. Run `hmm install` to install all haxelibs of the current branch
4. Run `haxelib run lime setup` to set up lime
Expand Down

0 comments on commit 9bd09e3

Please sign in to comment.