Skip to content

Commit e3a4ac2

Browse files
authored
Add ZeroSyntax VSCode extension (TheSuperHackers#18)
* doc: Added documentation for ZeroSyntax INI linter vscode extension.
1 parent 015570a commit e3a4ac2

File tree

2 files changed

+73
-0
lines changed

2 files changed

+73
-0
lines changed

Asset/GameDesign/ini/ini-linter.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# ZeroSyntax VSCode Extension
2+
3+
Working with INI files can be a bit of a pain, because of the custom syntax defined by the developers. If a single
4+
line contains a syntax error, the entire game can crash. Because of this, an extension for Visual Studio Code was
5+
created by @ViTeXFTW to help with linting INI files. This extension is called ZeroSyntax.
6+
7+
## Features
8+
9+
The ZeroSyntax extension pack comes with 4 main features:
10+
11+
1. Syntax highlighting for INI files.
12+
This changes how VSCode displays the INI files, making it easier to read and understand the contents.
13+
14+
2. Formatting for INI files.
15+
When working with older files or when expirmenting, INI files can be come messy. This feature will clean up the file
16+
and make correct indentation based on the indentation settings in VSCode.
17+
18+
3. Linting for INI files.
19+
This feature will check the INI file for syntax errors and highlight them in the editor. This can help prevent crashes
20+
when working with INI files.
21+
22+
4. Code Completion for INI files.
23+
This feature will provide suggestions for tags and values when working with INI files. This can help speed up
24+
development and prevent typos.
25+
26+
## Installation
27+
28+
Instaltion is super easy, and can be done stright from the editor.
29+
Use this link: [ZeroSyntax Pack](vscode:extension/vitexftw.zs-pack) or one of the following methods:
30+
31+
### Visual Studio Code
32+
33+
1. Go to the extensions tab in the sidebar.
34+
2. Search for `ZeroSyntax`.
35+
3. Select the desired extension and click install.
36+
37+
### Visual Studio Code Marketplace
38+
39+
1. Go to the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ViTeXFTW.zs-pack).
40+
2. Click on the install button.
41+
3. Press the `Open in Visual Studio Code` button.
42+
4. Select the desired extension and click install.
43+
44+
### Visual Studio Extension
45+
46+
**Comming Soon...**
47+
48+
> [!NOTE]
49+
> You might need to reload the editor after installing the extension for it to take effect.
50+
51+
## How to use
52+
53+
### Highlighting
54+
55+
The highlighter will automatically start working once the extension is installed. You can open up an INI file and see
56+
the syntax highlighting in action.
57+
58+
### Linting
59+
60+
Similarly to the highlighting, the linting will automatically start working once the extension is installed. If there
61+
are any syntax errors in the file, they will be highlighted in the editor.
62+
63+
### Formatting
64+
65+
If you want to format the file, you can press `Ctrl + Shift + P` and find the `Format Document` command. This will
66+
clean up the file and make it easier to read.
67+
68+
### Code Completion
69+
70+
When working in an INI file the editor will provide you with suggestions for the next token. This can be Classes
71+
like `Objects`, `Armor`, `Weapons`, etc. or Modules like `Draw`, `Body`, `Behavior`, etc. If an assignment is
72+
expected to have an object as a value, the editor will only suggest objects.

Asset/_Navbar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- Game Design
1515
- INI
1616
- [INI Files](GameDesign/ini)
17+
- [ZeroSyntax VSCode Extension](GameDesign/ini/ini-linter.md)
1718
- SCB
1819
- [SCB Links](GameDesign/scb/links.md)
1920
- Maps

0 commit comments

Comments
 (0)