Documentation
Readme
View as plain text
Name:
Papyrus Assembly package for Sublime Text 2
By:
Cipscis (Mark Hanna)
Version:
1.00
Description:
This is a package for Sublime Text 2 that makes it easier to view Papyrus assembly files (file extension .pas). These files can be generated in 2 ways:
* Running the Papyrus compiler with either the -keepasm or -asmonly command line arguments. The former compiles the script but keeps the assembly file, whereas the latter does not compile the script and only generates the assembly file.
* Running the Papyrus assembler with the -D command line argument to decompile a compiled script (file extension .pex).
Papyrus assembly can be converted into fully compiled Papyrus scripts by running it through the Papyrus assembler. A build system is included in the package to make this easy.
Installation:
Extract the "Papyrus Assembly" folder into the Packages directory for your Sublime Text 2 installation. This can usually be found here:
"C:\Users\username\AppData\Roaming\Sublime Text 2\Packages"
That's it. Now you should be able to open files with the .pas extension in Sublime Text 2 and they'll automatically use the syntax highlighting I've defined.
A build system for
Uninstallation:
Just delete the "Papyrus Assembly" folder from your Packages directory to uninstall this package.
If you've also installed the "Decompile Papyrus" build system for decompiling scripts, then delete the "Decompile Papyrus.sublime-build" file from your Packages/User folder.
Use:
To assemble these files into fully compiled scripts, press your "build" keyboard shortcut (Ctrl+B or F7 both work by default) or select "Build" under Tools. For this to work, either "Papyrus Assembly" or "Automatic" need to be selected under Tools > Build System.
To use the "Decompile Papyrus" build system to generate assembly files from compiled scripts, open up the compiled script in Sublime Text 2 (it should have a file extension of .pex), select "Decompile Papyrus" under Tools > Build System, then run the build system either from "Build" under Tools or via the keyboard shortcut.
If either of the build packages doesn't work right away, you may need to alter it to match your Skyrim installation directory. Open up the Papyrus Assembly.sublime-build file and edit the path to match your own.
Generating Assembly Files:
If you're a Sublime Text 2 user and a Papyrus scripter, you probably already have the Papyrus build system availabe via the Creation Kit wiki set up. In order to easily generate Papyrus assembly files, I recommend you manually edit your ScriptCompile.bat file (in the "Papyrus Compiler" folder in your Skyrim installation directory) to include the -keepasm command line argument.
Assembly files are generated in the same folder as the compiled script, not the source.
Here is the usage information for the Papyrus compiler as reported via its -? command line argument:
Usage:
PapyrusCompiler