Skip to content

Commit 40e229e

Browse files
authored
Update README.md
1 parent c3d0312 commit 40e229e

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# gdscript
2-
GDScript support for Text Forge code editor
1+
# Text Forge GDScript mode
2+
Official GDScript mode for Text Forge code editor
3+
4+
---
5+
6+
GDScript Mode is a lightweight and functional mode for Text Forge code editor. It's a part of official Text Forge modes.
7+
8+
## Mode Features
9+
- Updated to [Text Forge Mode API V2.0](https://github.com/text-forge/text-forge/pull/71)
10+
- Outline system with main functions (same as Godot script editor)
11+
- Simple code highlighter, with same colors as Godot default highlighter
12+
- Simple code completion with keywords
13+
- Linter is in progress ⚠️
14+
15+
## Setup
16+
Supports Text Forge 0.1-stable and newer versions.
17+
18+
### Method 1: From releases
19+
- Download `gdscript.tfmode` file from releases.
20+
- Open Text Forge and go to Settings > Mode Manager > Import Mode and select kit file.
21+
- Mode kit is ready to use. Please restart editor for safer experience.
22+
23+
### Method 2: From repo
24+
- Download repo as zip and extract it.
25+
- Open editor data folder (use Settings > Open Data Folder)
26+
- Copy `modes/` folder content to data `modes/`.
27+
- Restart editor.
28+
29+
### Development
30+
This project is under Text Forge organization and MIT license, so all contribution and development process is same as Text Forge project, for more information see [online docs](https://text-forge.github.io/docs).

0 commit comments

Comments
 (0)