Difference between revisions of "Visual Studio Code"
Added categories
imported>ChikkenChazer (Introduced usage and compilation guide) |
imported>Qazaaq (Added categories) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
'''Visual Studio Code''' is a source code editor developed by Microsoft. It includes support for debugging, embedded Git control, syntax highlighting, intelligent code completion, snippets, and code refactoring. It is also customizable, so users can change the editor's theme, keyboard shortcuts, and preferences. It is free and open-source, although the official download is under a proprietary license. | '''Visual Studio Code''' is a source code editor developed by Microsoft. It includes support for debugging, embedded Git control, syntax highlighting, intelligent code completion, snippets, and code refactoring. It is also customizable, so users can change the editor's theme, keyboard shortcuts, and preferences. It is free and open-source, although the official download is under a proprietary license. | ||
| Line 13: | Line 11: | ||
===Install packages=== | ===Install packages=== | ||
* Papyrus [https://marketplace.visualstudio.com/items?itemName=plankton020.papyrus] (syntax highlighting) | * Papyrus [https://marketplace.visualstudio.com/items?itemName=plankton020.papyrus] (syntax highlighting) | ||
* Papyrus Compiler [https://marketplace.visualstudio.com/items?itemName=mr-andersen.vs-papyrus-compiler] (run the Papyrus compiler from the command menu) | |||
==Usage== | ==Usage== | ||
After installing VS Code, install the | After installing VS Code, install the Papyrus packages by browsing to the package's extension page and click install or the VS Code's extension installer (CTRL+SHIFT+X) | ||
If your project is using project files (.ppj) you may want to associate .ppj files as XML | If your project is using project files (.ppj) you may want to associate .ppj files as XML | ||
| Line 44: | Line 43: | ||
===Compilation=== | ===Compilation=== | ||
If you want to compile your Papyrus scripts from within Visual Studio Code you can utilize VS Code's build and tasks system. | If you want to compile your Papyrus scripts from within Visual Studio Code you can use the Papyrus Compiler package (see packages section). The package contributes commands to VSC for running the Papyrus compiler. See the package homepage for setup. | ||
Alternatively you can utilize VS Code's build and tasks system. | |||
====Using the build and tasks system==== | |||
Note: Replace occurences of '''<GAME-DIRECTORY>''' with the path to the directory where your game is installed (Eg.: '''C:\Program Files (x86)\Steam\steamapps\common\Fallout 4''') | Note: Replace occurences of '''<GAME-DIRECTORY>''' with the path to the directory where your game is installed (Eg.: '''C:\Program Files (x86)\Steam\steamapps\common\Fallout 4''') | ||
====Compile single file using default build task==== | =====Compile single file using default build task===== | ||
# First add the [[#Files|ScriptCompileDevVS.bat]] to your '''<GAME-DIRECTORY>\Data\Scripts\Source\User''' directory. The bat file contains basic compiler configuration for development. | # First add the [[#Files|ScriptCompileDevVS.bat]] to your '''<GAME-DIRECTORY>\Data\Scripts\Source\User''' directory. The bat file contains basic compiler configuration for development. | ||
| Line 58: | Line 61: | ||
Now, you may test to see if everything is working as expected by opening one of your .tsc files. Press CTRL+SHIFT+B (Run Build Task) to compile. | Now, you may test to see if everything is working as expected by opening one of your .tsc files. Press CTRL+SHIFT+B (Run Build Task) to compile. | ||
The built-in terminal should automatically open and output the results. | The built-in terminal should automatically open and output the results. | ||
If everything has been configured correctly you should see the compilation | If everything has been configured correctly you should see the compilation success message. | ||
Tasks can be tweaked to better suit your particular needs. Please consult the documentation for more information: https://code.visualstudio.com/docs/editor/tasks | Tasks can be tweaked to better suit your particular needs. Please consult the documentation for more information: https://code.visualstudio.com/docs/editor/tasks | ||
| Line 65: | Line 68: | ||
You may also create a task for each step in the workflow (development, release, final etc.) | You may also create a task for each step in the workflow (development, release, final etc.) | ||
====Compile file on CTRL+S==== | =====Compile file on CTRL+S===== | ||
If you want to compile the edited file every time you save the file (CTRL+S) you can add a hook in keybindings.json | If you want to compile the edited file every time you save the file (CTRL+S) you can add a hook in keybindings.json | ||
# Choose File > Preferences > Keyboard Shortcuts | |||
# Click the keybindings.json link at the top of the screen (below the search input) | |||
# In your keybindings.json add the following JSON object to the JSON array (between the brackets) | |||
<source lang="javascript"> | <source lang="javascript"> | ||
| Line 122: | Line 125: | ||
} | } | ||
</source> | </source> | ||
==See Also== | ==See Also== | ||
*[[:Category:Text Editors|Other Text Editors]] | *[[:Category:Text Editors|Other Text Editors]] | ||
[[Category:Text Editors]] | |||
[[Category:Scripting]] | |||
[[Category:Tooling]] | |||