Home - joelday/papyrus-lang GitHub Wiki
You can now write mods for Skyrim and Fallout 4 with the aid of modern code editing features such as Intellisense, Jump to Definition, Symbol Search, and live updated diagnostics.
New to VS Code? To get the most out of Visual Studio Code, start by reviewing a few introductory topics in the VS Code Documentation. Do you already use another IDE for Papyrus development? Read about what VS Code has to offer to see why the switch is worth it.
If your question is not covered here then consider visiting the Issue Tracker or join us on Discord.
Quick Start
A quick start for the Papyrus Language extension covering requirements, installation, and configuration.
Requirements
The Papyrus Language extension has flexible requirements. If you have ever modded the game before then you likely already meet these requirements. See also the Questions page.
- Have a supported game installed such as Skyrim or Fallout 4.
- Have the Creation Kit installed and included base scripts extracted. The Creation Kit requires a supported game to be installed.
- Optionally have xSE installed for Debugging support.
Installation
The Papyrus Language extension installs with ease.
Click Here: https://marketplace.visualstudio.com/items?itemName=joelday.papyrus-lang-vscode
- Meet the requirements for this extension.
- To install the Papyrus Language extension, open the VS Code Extensions View and search for Joel Day's
Papyrus. - Open your Papyrus source files and begin coding. Optionally, customize Configurations for the Papyrus Language extension. After installation, the extension will automatically detect your game directories by reading the windows registry.
Features
This extension supports several advanced features that developers are accustomed to in other language IDEs.
| Feature | Skyrim | Skyrim SE | Fallout 4 |
|---|---|---|---|
| Language Definition | Yes | Yes | Yes |
| Static Analysis | Yes | Yes | Yes |
| IntelliSense | Yes | Yes | Yes |
| Refactoring | Yes | Yes | Yes |
| Compilation | Yes | Yes | yes |
| Debugging | No | Yes | Yes |
Settings
These are all the settings provided by the Papyrus Language extension. Read more about using VS Code Settings.
- papyrus.skyrim.enabled
- papyrus.skyrim.installPath
- papyrus.skyrim.creationKitIniFiles
- papyrus.skyrimSpecialEdition.enabled
- papyrus.skyrimSpecialEdition.installPath
- papyrus.skyrimSpecialEdition.creationKitIniFiles
- papyrus.skyrimSpecialEdition.ignoreDebuggerVersion
- papyrus.fallout4.enabled
- papyrus.fallout4.installPath
- papyrus.fallout4.creationKitIniFiles
- papyrus.fallout4.ignoreDebuggerVersion
Commands
These are all the commands provided by the Papyrus Language extension. Read more about using commands with the VS Code Command Palette.