|
3 | 3 | ## Installation |
4 | 4 |
|
5 | 5 | - Clone the source code of [godot](https://github.com/godotengine/godot): |
6 | | - - `git clone git@github.com:godotengine/godot.git` or |
7 | | - - `git clone https://github.com/godotengine/godot.git` |
8 | | -- This branch uses version `4.4` so checkout the version with: `git checkout 4.4` |
| 6 | + - `git clone git@github.com:godotengine/godot.git` or |
| 7 | + - `git clone https://github.com/godotengine/godot.git` |
| 8 | +- This branch uses version `4.5` so checkout the version with: `git checkout 4.5` |
9 | 9 | - Clone this module and put it into `godot/modules/GodotJS`: |
10 | | - - `git clone git@github.com:godotjs/GodotJS.git godot/modules/GodotJS` or |
11 | | - - `git clone https://github.com/godotjs/GodotJS.git godot/modules/GodotJS` |
12 | | -- Download the prebuilt v8 from [GodotJS-Dependencies](https://github.com/ialex32x/GodotJS-Dependencies/releases): |
13 | | - - `curl https://github.com/ialex32x/GodotJS-Dependencies/releases/download/v8_12.4.254.21_r13/v8_12.4.254.21_r13.zip --output your/download/path/v8.zip` |
14 | | - - `7z x -o "YourGodotEngineSource/modules/GodotJS" your/download/path/v8.zip` |
| 10 | + - `git clone git@github.com:godotjs/GodotJS.git godot/modules/GodotJS` or |
| 11 | + - `git clone https://github.com/godotjs/GodotJS.git godot/modules/GodotJS` |
15 | 12 | - [Recompile the godot engine](https://docs.godotengine.org/en/4.4/development/compiling/index.html) |
16 | | - - Windows: `scons platform=windows` |
17 | | - - MacOS: `scons platform=macos arch=arm64` |
18 | | - - **Hint**: To enable unit tests you need to add `tests=true` to `scons` arguments |
| 13 | + - Windows: `scons platform=windows` |
| 14 | + - MacOS: `scons platform=macos arch=arm64` |
| 15 | + |
| 16 | +### Hints |
| 17 | + |
| 18 | +- To enable unit tests you need to add `tests=true` to `scons` arguments |
| 19 | +- To debug C++ code in [CLion](https://docs.godotengine.org/en/4.4/contributing/development/configuring_an_ide/clion.html#importing-the-project) you might need to add `compiledb=yes` to `scons` arguments once |
19 | 20 |
|
20 | 21 | ## Project Structure |
21 | 22 |
|
@@ -53,3 +54,14 @@ Before submitting your PR add a [Changeset](https://github.com/changesets/change |
53 | 54 |
|
54 | 55 | - From the root, run `pnpm run changeset` and follow the CLI instructions |
55 | 56 | - You can add a full description of your change in Markdown format |
| 57 | + |
| 58 | +## Pre-release as maintainer |
| 59 | + |
| 60 | +If you want to create a pre-release to test build targets you need to [draft a new release](https://github.com/godotjs/GodotJS/releases/new): |
| 61 | + |
| 62 | +- Create a new tag like `v1.2.3-test-xyz` and use the same name for the release title. |
| 63 | +- Next you can select a target branch - you don't have to pick `main`. |
| 64 | +- Make sure to check the `Set as a pre-release` checkbox. |
| 65 | +- Release notes are optional |
| 66 | + |
| 67 | + |
0 commit comments