Skip to content

Commit cdbb8c0

Browse files
authored
docs: update paths to editor builds and getting-started.md (#8)
1 parent 520abc6 commit cdbb8c0

File tree

4 files changed

+39
-12
lines changed

4 files changed

+39
-12
lines changed

docs/documentation/building-from-source/v8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,5 +172,5 @@ The currently used version of `v8` is `12.4.254.21`.
172172

173173
> **NOTE:** Since the prebuilt `v8` library is built with the `windows-latest` github runner which uses VS2022, encountering `Unresolved external symbol` errors during linkage with `v8_monolith.lib` or `libucrt.lib` may be addressed by updating to the latest version of the `MSVC v143` toolchain, `Windows Universal CRT SDK` and `Visual Studio 2022` itself. See [GodotJS-Dependencies README](https://github.com/ialex32x/GodotJS-Dependencies) for the version of MSVC C++ Compiler used in different prebuilt library packages.
174174
175-
A prebuilt version of `Godot Editor` can be downloaded from [GodotJS-Build](https://github.com/ialex32x/GodotJS-Build/releases).
175+
A prebuilt version of `Godot Editor` can be downloaded from [GodotJS-Build](https://github.com/godotjs/GodotJS/releases).
176176
**Because the GodotJS-Build workflow is currently run manually, it may not be built from the latest commit of `GodotJS`.**

docs/documentation/getting-started.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
1-
1. [Download the editor](https://github.com/ialex32x/GodotJS-Build/releases) and start the application
2-
2. Rename the downloaded file to `godot` and [add Godot to your path](https://docs.godotengine.org/en/stable/tutorials/editor/command_line_tutorial.html#path)
3-
3. Open a terminal
4-
4. Test if you can use Godot via terminal and run:
1+
1. [Download the `editor`](https://github.com/godotjs/GodotJS/releases) based on your OS and select an JS engine (we recommend `v8` for a start) and unzip it
2+
2. Rename the downloaded file based on your OS:
3+
- Linux: `godot.linuxbsd.editor.x86_64` ➡️ `godot`
4+
- MacOS: no rename required
5+
- Windows: `godot.windows.editor.x86_64.exe` ➡️ `godot.exe`
6+
3. [Add Godot to your PATH](https://docs.godotengine.org/en/stable/tutorials/editor/command_line_tutorial.html#path)
7+
- Linux: `/usr/local/bin`
8+
- MacOS: `echo ~/your-path/Godot.app/Contents/MacOS|sudo tee /etc/paths.d/godot;bash -l;echo $PATH`
9+
- Windows: `setx /M path "%path%;C:\your-path\windows-editor-v8"`
10+
4. Open a terminal
11+
5. Test if you can use Godot via terminal and run:
512

613
```shell
714
godot --version
815
```
916

17+
> **Note:** The `Godot.app` isn't signed for MacOS you need to [allow to open it](https://support.apple.com/en-us/102445#:~:text=If%20you%20want%20to%20open%20an%20app%20that%20hasn%E2%80%99t%20been%20notarized%20or%20is%20from%20an%20unidentified%20developer).
18+
1019
## Create a new project
1120

1221
### Automatically with [godot-ts](https://github.com/godotjs/godot-ts)
@@ -41,7 +50,7 @@ To create new scripts, press select GodotJSScript as language:
4150

4251
![Select Language](images/tsproj_select_godotjs.png)
4352

44-
Use the ``Node: Node.Ts`` template:
53+
Use the `Node: Node.Ts` template:
4554

4655
![Create a Script](images/tsproj_create_script.png)
4756

docs/documentation/godot-js-scripts/npm-dependencies.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@ Currently, `GodotJS` doesn't provide sufficient support for using code from npm
66
- How the typescript/javascript project is packaged (archive into a single script file or not)
77
- Javascript modular standard variants may be involved
88

9-
If a npm package just works, there is no guarantee that it does also work after packaging, `GodotJS` tries to export all dependant javascript sources into the targeting package.
9+
## Workaround as bundle
1010

11-
> **NOTE:** See [read_xlsx.ts](https://github.com/ialex32x/GodotJSExample/blob/main/tests/read_xlsx.ts) about using a npm package.
11+
Try to bundle npm dependencies to an own file to avoid potential conflicts.
12+
13+
If you use [godot-ts](https://github.com/godotjs/godot-ts) you can create a `*.bundle.ts` file like this:
14+
15+
```ts npm.bundle.ts
16+
export { default as dayjs } from "dayjs";
17+
```
18+
19+
```ts example.ts
20+
import { Label, Node } from "godot";
21+
import { dayjs } from "./npm.bundle";
22+
23+
export default class Example extends Node {
24+
_ready(): void {
25+
const label: Label = this.get_node("Label") as Label;
26+
27+
label.text = dayjs().toString();
28+
}
29+
}
30+
```

docs/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ hide:
66

77
# **GodotJS**
88

9-
**_-- JavaScript and TypeScript language binding for Godot game engine --_**
9+
**_-- TypeScript/JavaScript Support for Godot 4.x by leveraging the high-performance capabilities of V8 to bring the delightful development experience of TypeScript into Godot.
10+
--_**
1011

1112
Supports JavaScript engines:
1213

@@ -39,11 +40,9 @@ No installation or setup necessary.
3940
The binaries for download are the complete, usable Godot editor
4041
and engine with JavaScript/TypeScript language support.
4142

42-
> **NOTE:** The GodotJS-Build workflow is currently run manually, it may not be built from the latest version of GodotJS.
43-
4443
### Binary downloads
4544

46-
Download the binaries from the [GodotJS-Build](https://github.com/ialex32x/GodotJS-Build/releases).
45+
Download the binaries from the [Releases](https://github.com/godotjs/GodotJS/releases).
4746

4847
### Choose your engine
4948

0 commit comments

Comments
 (0)