Difference between revisions of "Visual Studio Code"
Jump to navigation
Jump to search
(Expand article to feature HPL2 config) |
(comment out faulty tutorial (for now) and add info about linter) |
||
| Line 18: | Line 18: | ||
** <code>*.cfg</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. | ** 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. | ||
| + | ** 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. | ||
| + | There do exist a few AngelScript plugins for VS Code, but none of them are any good (and several of them are abandoned). | ||
| + | |||
| + | <!-- | ||
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. | 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++. | 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]. | 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 == | == HPL3 == | ||
''Main article: [[HPL3/Scripting/Scripting Guide/Setting up Visual Studio Code | Setting up Visual Studio Code]]'' | ''Main article: [[HPL3/Scripting/Scripting Guide/Setting up Visual Studio Code | Setting up Visual Studio Code]]'' | ||
Revision as of 15:57, 23 March 2024
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).
An open-source version is available: 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 here and more about git in VS Code 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:
*.hpswith a value ofcpp*.langwith a value ofxml*.cfgwith a value ofxml- 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.
- 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. There do exist a few AngelScript plugins for VS Code, but none of them are any good (and several of them are abandoned).
HPL3
Main article: Setting up Visual Studio Code