Skip to content

Commit 9bcfceb

Browse files
committed
chore: removed godot-ts reference it's not required anymore
1 parent 31525a5 commit 9bcfceb

File tree

4 files changed

+8
-45
lines changed

4 files changed

+8
-45
lines changed

docs/documentation/getting-started.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,6 @@ godot --version
1818
1919
## Create a new project
2020

21-
### Automatically with [godot-ts](https://github.com/godotjs/godot-ts)
22-
23-
1. Run `npx -y @godot-js/godot-ts init` (new project will be crated at your current terminal path)
24-
2. Follow the prompts
25-
3. Run `cd <your-project>`
26-
4. Run `npm i`
27-
5. Run `npm run dev` - this will enable typescript watch mode and opens the editor
28-
6. Inside the editor [install preset files](#install-preset-files) via `Project > Tools > GodotJS > Install Preset files`
29-
7. Click `OK` to confirm a list of files will be generated in the project.
30-
8. Attach the `example.ts` script to a node and run the project
31-
32-
### Manually
33-
3421
1. Run `godot -p` and create a new project
3522
2. Inside the editor [install preset files](#install-preset-files) via `Project > Tools > GodotJS > Install Preset files`
3623
3. Click `OK` to confirm a list of files will be generated in the project.
@@ -58,7 +45,7 @@ Open the project folder in you IDE, you should see full TypeScript support!
5845

5946
![Type Hint](images/tsproj_type_hint.png)
6047

61-
## Compile TypeScript Sources without [godot-ts](https://github.com/godotjs/godot-ts)
48+
## Compile TypeScript Sources
6249

6350
Before your scripts runnable in _Godot_, run `tsc` to compile typescript sources into javascript.
6451

docs/documentation/godot-js-scripts/intro.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,10 @@ Check out [decorators](decorators.md) for more information.
7171

7272
By default, GodotJS wil auto generate some TypeScript files based on you project.
7373
Check out [auto-completion](auto-completion-and-codegen.md) for more information.
74+
75+
## NPM Dependencies
76+
77+
Currently, `GodotJS` doesn't provide full support for using code from npm packages.
78+
Because many factors are involved in it, such as:
79+
80+
- Scripts depend on functionalities of node.js which is not supported

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

Lines changed: 0 additions & 30 deletions
This file was deleted.

mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ nav:
1414
- Intro: documentation/godot-js-scripts/intro.md
1515
- Decorators: documentation/godot-js-scripts/decorators.md
1616
- Signals: documentation/godot-js-scripts/signals.md
17-
- NPM Dependencies: documentation/godot-js-scripts/npm-dependencies.md
1817
- Cyclic Imports: documentation/godot-js-scripts/cyclic-imports.md
1918
- Bindings: documentation/godot-js-scripts/bindings.md
2019
- Running code in editor: documentation/godot-js-scripts/code-in-editor.md

0 commit comments

Comments
 (0)