-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update docs to match new repo (#207)
* chore: update docs to match new repo * chore: add mobile icon * fix: issue with static checks
- Loading branch information
Showing
19 changed files
with
82 additions
and
686 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,19 @@ | ||
# GodotJS - JavaScript language binding for Godot game engine | ||
<picture> | ||
<source media="(mmin-width: 720px)" srcset="docs/header.svg"> | ||
<img src="docs/header-mobile.svg" width="900" height="330" alt="GodotJS Logo"> | ||
</picture> | ||
|
||
# **GodotJS** | ||
|
||
***-- JavaScript and TypeScript language binding for Godot game engine --*** | ||
|
||
This module implements JavaScript/TypeScript language support for the Godot game engine using [QuickJS](https://bellard.org/quickjs/) as the JavaScript engine. | ||
|
||
|
||
## Getting started | ||
|
||
Read the [getting-started](https://godotjs.github.io/documentation/getting-started/). | ||
|
||
## Features | ||
|
||
- Almost complete ES2020 support | ||
|
@@ -13,10 +25,6 @@ This module implements JavaScript/TypeScript language support for the Godot game | |
- Full code completion support for all Godot APIs including signals and enumerations | ||
- Debug in Visual Studio Code with the [plugin](https://marketplace.visualstudio.com/items?itemName=geequlim.godot-javascript-debug) - currently not available for 4.x | ||
|
||
### Getting started | ||
|
||
Read the [getting-started](https://geequlim.github.io/ECMAScript/getting-started). | ||
|
||
## Getting the engine | ||
|
||
No installation or setup necessary. The binaries for download are the complete, usable Godot editor and engine with JavaScript/TypeScript language support. | ||
|
@@ -32,22 +40,23 @@ Download the binaries from the [release page](https://github.com/GodotExplorer/E | |
- `git clone https://github.com/godotengine/godot.git` | ||
- This branch uses version `4.1` so checkout the version with: `git checkout 4.1` | ||
- Clone this module and put it into `godot/modules/javascript`: | ||
- `git clone [email protected]:Geequlim/ECMAScript.git godot/modules/javascript` or | ||
- `git clone https://github.com/Geequlim/ECMAScript.git godot/modules/javascript` | ||
- `git clone [email protected]:godotjs/javascript.git godot/modules/javascript` or | ||
- `git clone https://github.com/godotjs/javascript.git godot/modules/javascript` | ||
- [Recompile the godot engine](https://docs.godotengine.org/en/4.1/development/compiling/index.html) | ||
- Use `scons` with those additional options `warnings=extra werror=yes module_text_server_fb_enabled=yes` to show all potential errors: | ||
- Windows: `scons platform=windows warnings=extra werror=yes module_text_server_fb_enabled=yes` | ||
- MacOS: `scons platform=macos arch=arm64 warnings=extra werror=yes module_text_server_fb_enabled=yes` | ||
|
||
## Documentation, Tutorials & Demos | ||
|
||
Read this [documentation](https://geequlim.github.io/ECMAScript/getting-started) or look at the tutorials or demos: | ||
|
||
- [ECMAScriptDemos](https://github.com/Geequlim/ECMAScriptDemos) - Demos | ||
Read this [documentation](https://godotjs.github.io/documentation/getting-started/) or look at the tutorials or demos: | ||
|
||
- [ECMAScriptDemos](https://github.com/godotjs/javascriptDemos) - Demos | ||
- [godot-ECMAScript-cookbook](https://github.com/why-try313/godot-ECMAScript-cookbook/wiki) - Tutorial | ||
- [godot-typescript-starter](https://github.com/citizenll/godot-typescript-starter) - Template | ||
- [godot-js-template](https://github.com/fukaraadam-workspace/godot-js-template) - Template | ||
|
||
## Contributing | ||
|
||
If you like to contribute to this project check the [CONTRIBUTING.md](https://github.com/Geequlim/ECMAScript/blob/master/CONTRIBUTING.md) file. | ||
If you like to contribute to this project check the [CONTRIBUTING.md](https://github.com/godotjs/javascript/blob/master/CONTRIBUTING.md) file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../icon/JavaScript.svg: https://commons.wikimedia.org/wiki/File:Unofficial_JavaScript_logo.svg |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.