Visual Studio Code - Revision history

Darkfire: Correct information about VS Code, add tutorial link

2024-03-24T10:51:29Z

Correct information about VS Code, add tutorial link

Darkfire: fix formatting, clarify notes about extensions

2024-03-23T17:52:49Z

fix formatting, clarify notes about extensions

Darkfire: comment out faulty tutorial (for now) and add info about linter

2024-03-23T13:57:46Z

comment out faulty tutorial (for now) and add info about linter

Darkfire: Expand article to feature HPL2 config

2024-03-23T13:19:48Z

Expand article to feature HPL2 config

Darkfire: Created

2020-11-09T19:59:04Z

Created

New page

Visual Studio Code is a lightweight notepad-esque version of Microsoft's full IDE Visual Studio. It can be used for programming for HPL.

[[HPL3/Scripting/Scripting Guide/Setting up Visual Studio Code |'''Click here to view a guide of setting up and using the tool''']].

@@ Line 1: / Line 1: @@
-Visual Studio Code is a lightweight code and config editor based on Microsoft's full IDE Visual Studio.
+Visual Studio Code is a lightweight code and config editor.
 Featuring an integrated project folder browser and a simple but powerful interface, it is one of the best tools for developing HPL2 mods (for HPL3 it works well too, but [[CodeLite]] might be a better option).
-An open-source version is available: [https://vscodium.com/ VSCodium]. It is functionally identical to VS Code.
+While VS Code is open-source, its releases still contain Microsoft's telemetry and tracking.
 == HPL2 ==
-* Open your mod folder
+* Check out the built-in tutorial and the [https://code.visualstudio.com/docs/introvideos/basics online tutorial]. Some particularly useful features are:
 ** Ctrl+Shift+F to search text in the entire project folder
 ** Alt+Up/Down arrows to move lines of code
 ** Ctrl+Shift+Alt+Up/Down to copy lines of code
 ** Built-in git version control interface (if you already have git installed). This is one of the more convenient ways of using git. Read more about version control [[Setting up an Online Repository | here]] and more about git in VS Code [https://code.visualstudio.com/docs/sourcecontrol/intro-to-git here].
 * Add highlighting for HPL2 file types; Open the settings menu (Ctrl+,) and search "file associations". You can do this in the User tab (global) or the Workspace tab (will only apply to this project folder). Then add:
 ** <code>*.hps</code> with a value of <code>cpp</code>

@@ Line 12: / Line 12: @@
 ** Ctrl+Shift+Alt+Up/Down to copy lines of code
 ** Built-in git version control interface (if you already have git installed). This is one of the more convenient ways of using git. Read more about version control [[Setting up an Online Repository | here]] and more about git in VS Code [https://code.visualstudio.com/docs/sourcecontrol/intro-to-git here].
-* Add highlighting for HPL2 file types; Open the settings menu (Ctrl+,) and search "file associations". You can do this in the User tab (global) or the Workspace tab (will only apply to this project folder).
+* Add highlighting for HPL2 file types; Open the settings menu (Ctrl+,) and search "file associations". You can do this in the User tab (global) or the Workspace tab (will only apply to this project folder). Then add:
 ** <code>*.hps</code> with a value of <code>cpp</code>
 ** <code>*.lang</code> with a value of <code>xml</code>
@@ Line 20: / Line 19: @@
 ** This will also add auto-completion for various things (like function names) that have been written anywhere else in the project.
-At the moment, there is no dedicated way of adding autocompletion for HPL2 script function signatures.
+Unlike HPL3, using a C++ extension will make things worse for you, as HPL2's style of scripting is not fully compatible with C++ standards (mainly; built-in functions don't have to and can't be included, and the <code>&in</code> <code>&out</code> syntax).
+There do exist a few AngelScript plugins for VS Code, but none of them are suitable (and several of them are abandoned).
-Unlike HPL3, using a C++ extension will make things worse for you, as HPL2's style of scripting is not fully compatible with C++ standards.
+As such, there is no good way of adding hints for built-in HPL2 script functions at the moment.
 == HPL3 ==
 ''Main article: [[HPL3/Scripting/Scripting Guide/Setting up Visual Studio Code | Setting up Visual Studio Code]]''

@@ Line 18: / Line 18: @@
 ** <code>*.cfg</code> with a value of <code>xml</code>
 ** You can also add associations for other HPL files, such as: .ent, .dae, .snt and so on. Pretty much all files in HPL2 use XML.
 Optional: Install the [https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools cpptools] extension to get better error detection and other helpful features for scripting.
 Note that using this extension will require some extra configuration because HPL's AngelScript is not pure C++.
 If you're using VSCodium, you will have to [https://stackoverflow.com/questions/42017617/how-to-install-vs-code-extension-manually install the extension manually].
-You can also check out the HPL3 section, as certain parts of it are also relevant to HPL2.
+You can also check out the HPL3 section, as certain parts of it are also relevant to HPL2. -->
 == HPL3 ==
 ''Main article: [[HPL3/Scripting/Scripting Guide/Setting up Visual Studio Code | Setting up Visual Studio Code]]''

← Older revision		Revision as of 13:19, 23 March 2024
Line 1:		Line 1:
−	Visual Studio Code is a lightweight ~~notepad-esque version of~~ Microsoft's full IDE Visual Studio. ~~It can be used~~ for ~~programming~~ for ~~HPL~~.	+	Visual Studio Code is a lightweight code and config editor based on Microsoft's full IDE Visual Studio.
		+	Featuring an integrated project folder browser and a simple but powerful interface, it is one of the best tools for developing HPL2 mods (for HPL3 it works well too, but [[CodeLite]] might be a better option).

−	[[HPL3/Scripting/Scripting Guide/Setting up Visual Studio Code \|~~'''Click here to view a guide of setting~~ up ~~and using the tool'~~''~~]].~~	+	An open-source version is available: [https://vscodium.com/ VSCodium]. It is functionally identical to VS Code.
		+
		+	== HPL2 ==
		+
		+	* Open your mod folder
		+	* Check out the built-in VS Code tutorial. Some particularly useful features are:
		+	** Ctrl+Shift+F to search text in the entire project folder
		+	** Alt+Up/Down arrows to move lines of code
		+	** Ctrl+Shift+Alt+Up/Down to copy lines of code
		+	** Built-in git version control interface (if you already have git installed). This is one of the more convenient ways of using git. Read more about version control [[Setting up an Online Repository \| here]] and more about git in VS Code [https://code.visualstudio.com/docs/sourcecontrol/intro-to-git here].
		+	* Add highlighting for HPL2 file types; Open the settings menu (Ctrl+,) and search "file associations". You can do this in the User tab (global) or the Workspace tab (will only apply to this project folder).
		+	Then add:
		+	** <code>*.hps</code> with a value of <code>cpp</code>
		+	** <code>*.lang</code> with a value of <code>xml</code>
		+	** <code>*.cfg</code> with a value of <code>xml</code>
		+	** You can also add associations for other HPL files, such as: .ent, .dae, .snt and so on. Pretty much all files in HPL2 use XML.
		+
		+	Optional: Install the [https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools cpptools] extension to get better error detection and other helpful features for scripting.
		+	This step is optional, as VS Code will still give you hints about code that you have already written once anywhere in the project.
		+	Note that using this extension will require some extra configuration because HPL's AngelScript is not pure C++.
		+	If you're using VSCodium, you will have to [https://stackoverflow.com/questions/42017617/how-to-install-vs-code-extension-manually install the extension manually].
		+
		+	You can also check out the HPL3 section, as certain parts of it are also relevant to HPL2.
		+
		+	== HPL3 ==
		+
		+	''Main article: [[HPL3/Scripting/Scripting Guide/Setting up Visual Studio Code \| Setting up Visual Studio Code]]''