@@ -7,7 +7,47 @@ Have you ever wanted to make 4D games in Godot?
77...no? You say you haven't? Ok, then this module isn't for you.
88
99For anyone who does want to make a 4D game, Node4D and other 4D nodes now
10- exist, just download the fork of Godot that includes this module!
10+ exist, just download and compile this module, and you can make 4D games in Godot!
11+
12+ ## Installation
13+
14+ First, have all the Godot dependencies installed on your computer as per the
15+ [ official instructions] ( https://docs.godotengine.org/en/stable/contributing/development/compiling/index.html ) .
16+
17+ If you want all of the Godot Dimensions modules at once, you can grab a
18+ branch of [ our Godot fork] ( https://github.com/godot-dimensions/godot ) .
19+
20+ ``` shell
21+ git clone https://github.com/godot-dimensions/godot godot-dimensions
22+ cd godot-dimensions
23+ # First, make sure you can compile regular Godot.
24+ scons
25+ # Then, switch to the dimensions branch and download the submodules.
26+ git switch dimensions-latest
27+ git submodule update --init --recursive
28+ scons
29+ # Re-run the `scons` command to re-compile if you make changes.
30+ ```
31+
32+ Alternatively, if you only want 4D, you can start with any clone
33+ of Godot Engine and add this module to it:
34+
35+ ``` shell
36+ cd modules
37+ git clone https://github.com/godot-dimensions/godot-4d 4d
38+ # Make sure the folder is named `4d`, not `godot-4d`!
39+ cd ..
40+ scons
41+ # Re-run the `scons` command to re-compile if you make changes.
42+ ```
43+
44+ It should now be successfully compiled, and you can run the executable in the ` bin ` folder.
45+
46+ Alternatively, Godot 4D can be compiled as a GDExtension. The module approach
47+ is recommended, but GDExtension allows you to avoid recompiling Godot.
48+ To compile as a GDExtension, clone this repository anywhere, with submodules,
49+ and run ` scons target=editor ` . You can open the repository's ` project.godot `
50+ in Godot to test the GDExtension, and copy the ` addons/4d ` to your own project.
1151
1252## Nodes
1353
0 commit comments