Skip to content

Commit d7d72da

Browse files
authored
(#28) Updated Build Docs for Windows
1 parent 8a15e00 commit d7d72da

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

docs/BUILDING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,32 @@
11
# Building TechNotDrip Engine
2+
3+
## Platforms:
4+
* [Windows](#Windows)
5+
* [Android](#Android)
6+
7+
## Windows:
8+
### Prerequisites:
9+
1. [Haxe](https://haxe.org/) installed
10+
2. [Git](https://git-scm.com/) installed
11+
3. Visual Studio Build Tools (C++ workload)
12+
4. Windows SDK installed
13+
14+
### Steps:
15+
1. Setup Haxelib (if not already setup) by running `haxelib setup`
16+
2. Install required tooling. Run the following:
17+
- `haxelib git haxelib https://github.com/FunkinCrew/haxelib.git funkin-patches`
18+
- `haxelib git hmm https://github.com/FunkinCrew/hmm funkin-patches`
19+
3. Install project dependencies. Run these inside the project root which should contain `hmm.json`
20+
- `cd <project-root>`
21+
- `haxelib run hmm install -q`
22+
4. Build hxcpp tools (one-time per machine)
23+
- Find the active haxelib repository path by running `haxelib config`
24+
- Go to the `hxcpp` folder by running `cd <haxelib-config-path>\hxcpp\git\tools\hxcpp`
25+
- Now that you're in the right folder, run `haxe compile.hxml`
26+
5. We can now finally build the project
27+
- Return to the project root by running `cd <project-root>`
28+
- Finally, you can build the engine by running `haxelib run lime build windows`
29+
230
## Android:
331
1. Install Android Studio from [developer.android.com](https://developer.android.com/studio)
432
2. Install Java 17 from [oracle.com](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)

0 commit comments

Comments
 (0)