I'm here to announce SublimePapyrus, a project that got its start in http://www.gamesas.com/topic/1501584-which-editor-do-you-use-for-papyrus/ a few days ago. http://www.gamesas.com/user/867339-quad2core/ created a fantastic little program for processing Papyrus source files and creating Sublime snippets based on the templates we agreed upon.
What is SublimePapyrus?
SublimePapyrus is a Papyrus package for Sublime Text 2 and it is based on the original Papyrus package by Bethesda Game Studios and Mark Hanna. SublimePapyrus contains snippets for functions and events found in the vanilla Skyrim (1.9.32.0.8), SKSE (1.7.0 alpha) modified, and SkyUI SDK (4.1) classes. An easy-to-use program, PapyrusToSublimeSnippets, is also included to automate the process of creating snippets and updating the syntax definition. The repository will be updated when necessary and more classes may be added in the future.
How do I use the package?
- Install Sublime Text 2, if you do not have it yet. Launch it once in order to make sure all necessary folders are created. Check the Creation Kit wiki for instructions on how to set up the Papyrus compiler for use with external editors.
- Get a copy of SublimePapyrus from the repository (recommended) or the CK wiki, if the repository is inaccessible.
- Copy the folder labelled "Papyrus" to "%AppData%\Sublime Text 2\Packages" or "\Sublime Text 2\Data\Packages", if you are using the portable version of Sublime Text 2.
- Copy the contents of the folders labelled "SKSE" and/or "SkyUI", if you intend to make use of SKSE or the SkyUI SDK.
- If you have Skyrim installed outside of "C:\Program Files (x86)\Steam\steamapps\common\skyrim\" or "C:\Program Files\Steam\steamapps\common\skyrim\", then you need to open the Command Palette (CTRL+SHIFT+P), type in "Papyrus INI". An option called "Papyrus INI: Create default INI file" should show up. Select it and a file called "SublimePapyrus.ini" will be created in My Documents. This file contains paths to compiled scripts, script sources, and the Papyrus compiler. Edit the paths according to where you have installed Skyrim.
How do I use the program PapyrusToSublimeSnippets?
The program can be launched from anywhere and allows you to type in the path to the folder containing the Papyrus source files you wish to process. If you do not type in a path, then the program will process the folder the program is in. You can also type in the path to the folder you wish to output the resulting logs and snippets to. If you do not type in a path, then the resulting files will be output to a folder called "snippets" in the folder that the program is in. The snippets can then be copied over into the Papyrus package.
The program creates two logs: FunctionLog.txt and ClassLog.txt. These contain keywords, which are formatted for use in the Papyrus syntax definition (Papyrus.tmLanguage), based on the processed source files. The syntax definition can be found in the Papyrus package.
Where can I get SublimePapyrus?
The latest version can be downloaded from https://github.com/Kapiainen/SublimePapyrus. An archived version, which will be uploaded to the Creation Kit wiki, can be downloaded from http://www.creationkit.com/Sublime_Text_Setup, if the repository is inaccessible.