You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## JavaScript language binding for godot game engine
2
2
3
-
This module implements JavaScript/TypeScript language support for the godot game engine. [QuickJS](https://bellard.org/quickjs/) is used as the ECMAScript engine.
3
+
This module implements JavaScript/TypeScript language support for the godot game engine. [QuickJS](https://bellard.org/quickjs/) is used as the JavaScript engine.
4
4
5
5
-----
6
6
@@ -20,15 +20,15 @@ You can also get the binaries with lastest commits from the [github build action
20
20
21
21
### Compilation
22
22
* Clone the source code of [godot](https://github.com/godotengine/godot)
23
-
* Clone this module and put it into `godot/modules/` and make sure the folder name of this module is `ECMAScript`
23
+
* Clone this module and put it into `godot/modules/` and make sure the folder name of this module is `javascript`
24
24
*[Recompile the godot engine](https://docs.godotengine.org/en/3.3/development/compiling/index.html) <b>(Only MinGW is supported on Windows for now!)</b>
25
25
26
26

27
27
28
28
### Usage
29
29
30
30
##### How to export script class to godot
31
-
1. Define your ECMAScript class and inherit from a godot class then export it as the **default** entry
31
+
1. Define your JavaScript class and inherit from a godot class then export it as the **default** entry
32
32
```js
33
33
// The default export entry is treated as an exported class to godot
- Run the menu command `Project > Tools > ECMAScript > Generate TypeScript Project` from the godot editor to generate a TypeScript project
183
+
- Run the menu command `Project > Tools > JavaScript > Generate TypeScript Project` from the godot editor to generate a TypeScript project
184
184
- Run `tsc -w -p .` under your project folder in the terminal to compile scripts
185
185
186
186
#### Code completion
@@ -269,6 +269,6 @@ You can try demos in the [ECMAScriptDemos](https://github.com/Geequlim/ECMAScrip
269
269
* The script also build the `on_tag.yml` script which automates the github release publishing.
270
270
** The `on_tag.yml` functionality tries to sleep until all jobs with the same `sha` are completed. It should be fine to run whenever, but depending on how github actions culls long running jobs you might want to make sure that all/(most of) the builds look good before tagging.
271
271
* Linux ubsan asan build woes:
272
-
** The godot repo has ubsan and asan builds that we can't build from. Currently we skip them (get removed via the `build_github_actions.py` script).
273
-
** They should definitely be fixed & enabled at some point, **so please submit a PR if you have any ideas of how to do that!**
272
+
* The godot repo has ubsan and asan builds that we can't build from. Currently we skip them (get removed via the `build_github_actions.py` script).
273
+
* They should definitely be fixed & enabled at some point, **so please submit a PR if you have any ideas of how to do that!**
0 commit comments