Hello! Thanks for the tool. Couple of questions from user familliar with Papyrus and Notepad++ but not with programming-related stuff. Using Sublime 3 last build.
about Github page: >> Commands > Open script > This command brings up an input panel and uses the input string to find matching files in the import folders that have been defined in the settings. - what is commands? How I can use them? "Open script", for example. Didn't find it in all dropdown menus, tried even to write "open script" in the file with no results. Maybe it's hotkey command? If I go "File > Open file" then it doesn't brings up any input panel, just standart "browse files" window.
>> import: Earlier entries override later entries. If one wanted to override Skyrim's script sources with script sources from Skyrim Script Extender (SKSE), then the path to SKSE's script sources should have a lower index. - Maybe because English isn't my native but it looks like "Earlier override later" is "line1 path have higher priority over line2 path" while "to override Skyrim's with SKSE - SKSE should have a lower index" is "line2 path > line1 path". Can you elaborate? UPD: Figured out by testing
about settings: How I should set all things up to match yours? Because when I tried what you do on mod image I had different results.
Line 3. Type "e" > extends to "Event EventName(Parameters)", "EventName" is highlighted. All like in gif, but it gives me second "EndEvent" on line 9. screenshot Line 5. When started typing "oninit" instead of "Eventname" it doesn't show autocomplete stuff. And all line is pink. screenshot Maybe you holdede some hotkey? Line 6. When you chose "additem" it extends to "AddItem()" with cursor in "()". When I chose additem it extends to "AddItem(Form akItemToAdd, int aiCount = 1, bool abSilent = false)" with "Form akItemToAdd" highlighted and cursor after "Add". screenshot And it pink again. Yours not, mine is. God I started to hate that color.
"title": "The Elder Scrolls V: Skyrim", "compiler":"C:\\Steam\\steamapps\\common\\Skyrim Special Edition\\Papyrus Compiler\\PapyrusCompiler.Exe", "flags":"TESV_Papyrus_Flags.flg", "output": "", "import":["C:\\Steam\\steamapps\\common\\skyrim\\Data\\Scripts\\Source",], "arguments": []
This is my setting file, however when I try to compile a script it throws an error on my import setting. Im clueless, also. no settings works, even the default ones.
Looks like you at the very least have an extra comma (between a quotation mark and a square bracket) in the import line. That is likely to cause parsing issues.
Great work! But a comment that might save other users some headaches;
I got a message when trying to compile that the import path didn't exist, but it clearly did. I resolved this issue by actually saving the file before trying to compile it.
You can open the readme file with a text editor and read it, it is just text. Formatting is not applied when reading it as a text file, but the content is there just fine. Other than that, you can also view the readme file in the Github repository: link. The same goes for the license. In addition to that, there seem to be some Markdown preview packages available for Sublime Text 2 and 3, as well - even through Package Control - so you really should not need to download any external programs to read the readme. For example a quick Google search for "sublime text markdown preview" should produce relevant results. Hopefully that helps a bit.
First let me say that I really like SublimePapyrus. It catches 99% of my mistakes at the time of writing, and is a huge time saver. Great work!
Now, I've found a problem with Skyrim scripts that write to properties in other scripts. Here is an example:
Actor npc = (DWFWashbasinMarkerRef as DWFWashbasinMarkerScript).currentUser
currentUser is an Actor property of DWFWashbasinMarkerScript, which is attached to DWFWashbasinMarkerRef (an ObjectReference property in this script). There are no problems, SublimePapyrus doesn't complain. However, if I try to write to the property instead of reading it:
(DWFWashbasinMarkerRef as DWFWashbasinMarkerScript).currentUser = None
This is valid syntax, compiles without error or warning, and works as intended. But in SublimePapyrus it gets marked as an error, saying: "The left-hand side expression contains operators other than the dot operator." Can you fix this?
for anyone confused, in SublimeText 2, in Preference > Browse Packages
it opens a window explorer (not an Open File Dialog), and navigates you to X:\Users\**YourName**\AppData\Roaming\Sublime Text 2\Packages
The installedPackages folder, in which you are looking for is one folder behind where you navigated initially, i.e. ...AppData\Roaming\Sublime Text 2
I also created a folder called Papyrus in the initial Packages folder and dropped the two package files in it as well, since it works fine, i just left it; although i doubt you have to do that.
I've got an issue here. Maybe some of you guys can help me out. I fairly new on scripting and sublime, so I guess this something happened, thanks to my lack of knowledge. Right now, SublimePapyrus tells me, that the path for the compiler is undefined or invalid. After using this guide here: https://github.com/Scrivener07/SublimePapyrus/blob/master/README.md#create-default-ini-file I've learned that, I have to create a INI file, since I'm using a different installationpath. But my Sublime3 didn't know the command "create default INI file", after installing the packaged version. So I wrote one on my own.
also I had to set the settings of the user preferences to a new folder, where I placed the .ini
Spoiler:
Show
{ "ini_path": "D:/SublimePapyrus.ini", }
I have absolutly no clue what's going on here. I'm used to the CK, thats where I came from, I love to design questmods but the CK has its limits and I want to take the next step to integrate some new stuff in my work.
Have you tried the package-specific settings? I am on my laptop at the moment (with no Sublime Text) but it should be somewhere in the menus. If you use Anaconda or any other package for Sublime Text 3, then you probably know where the package-specific settings are. If not, Google might help, they were somewhere under the right side dropdown menus. The default and user settings will open like normal files for you to edit. Remember to copy-paste the relevant sections from the default to the user file, and only edit the user file. I think it worked that way, it is how I have been doing it. If it is not the recommended way, then I would also love to hear what the right way to do it is.
Hopefully that helps a bit.
Edit: Also, if you use Advanced Papyrus, you could point the path of the Papyrus compiler at the original Papyrus compiler, not the Advanced Papyrus wrapper. If you do not use Advanced Papyrus, then ignore this.
To anyone having this problem, I found the solution. The installation instruction seem to be a little bit incomplete. You do need to set the path to the compiler. However, it looks like the use of an .ini file is no longer supported. Instead, you need to edit the package settings for SublimePapyrus: Settings - Default (in sublime 2, you click through Preferences, Package Settings, SublimePapyrus, Settings - Default). You want to add the path to your compiler on the line where it says "Compiler": which is under the "Skyrim": section. Mine looks like this:
"compiler":"C:/Program Files (x86)/Steam/steamapps/common/Skyrim Special Edition/Papyrus Compiler/PapyrusCompiler.exe",
Be certain to use the correct slash "/", not "\". You also will want to set the "import": line to point to the appropriate script source folder, which in my case was:
"import": ["C:/Program Files (x86)/Steam/steamapps/common/Skyrim Special Edition/Data/Scripts/Source"],
I am not certain if the package is supposed to configure this automatically, and it just failed to do so in my case, or if a manual configuration is required for all users. I would note that I have both Skyrim and Skyrim Special Edition installed, and that everything works fine in terms of compiling and autocomplete with either when things are configured correctly.
Give Feedback
90 comments
Couple of questions from user familliar with Papyrus and Notepad++ but not with programming-related stuff.
Using Sublime 3 last build.
about Github page:
>> Commands > Open script > This command brings up an input panel and uses the input string to find matching files in the import folders that have been defined in the settings.
- what is commands? How I can use them? "Open script", for example. Didn't find it in all dropdown menus, tried even to write "open script" in the file with no results. Maybe it's hotkey command?
If I go "File > Open file" then it doesn't brings up any input panel, just standart "browse files" window.
>> import: Earlier entries override later entries. If one wanted to override Skyrim's script sources with script sources from Skyrim Script Extender (SKSE), then the path to SKSE's script sources should have a lower index.UPD: Figured out by testing- Maybe because English isn't my native but it looks like "Earlier override later" is "line1 path have higher priority over line2 path" while "to override Skyrim's with SKSE - SKSE should have a lower index" is "line2 path > line1 path". Can you elaborate?
about settings:
How I should set all things up to match yours? Because when I tried what you do on mod image I had different results.
Line 3. Type "e" > extends to "Event EventName(Parameters)", "EventName" is highlighted. All like in gif, but it gives me second "EndEvent" on line 9. screenshot
Line 5. When started typing "oninit" instead of "Eventname" it doesn't show autocomplete stuff. And all line is pink. screenshot Maybe you holdede some hotkey?
Line 6. When you chose "additem" it extends to "AddItem()" with cursor in "()".
When I chose additem it extends to "AddItem(Form akItemToAdd, int aiCount = 1, bool abSilent = false)" with "Form akItemToAdd" highlighted and cursor after "Add". screenshot And it pink again. Yours not, mine is. God I started to hate that color.
This is the error when I try to save it:
Error trying to parse settings: Invalid escape in Packages\User\SublimePapyrus.sublime-settings:30:15
Here is how I have mine setup right now:
{
"word_wrap": false,
"linter_on_save": true,
"linter_on_modified": true,
"linter_delay": 500,
"linter_panel_error_messages": false,
"linter_error_line_threshold": 2,
"intelligent_code_completion": true,
"intelligent_code_completion_function_event_parameters": true,
"tooltip_function_parameters": true,
"tooltip_function_docstring": true,
"tooltip_background_color": "#393939",
"tooltip_body_text_color": "#747369",
"tooltip_font_size": "12",
"tooltip_bold_text_color": "#ffffff",
"tooltip_heading_text_color": "#bfbfbf",
"tooltip_heading_font_size": "14",
"tooltip_max_width": 600,
"tooltip_max_height": 300,
"center_highlighted_line": true,
"highlight_build_errors": true,
"hide_successful_build_results": false,
"batch_compilation_warning": true,
"open_script_split_paths": true,
"modules":
{
"skyrim":
{
"title": "The Elder Scrolls V: Skyrim",
"compiler":"C:\Program Files (x86)\Steam\steamapps\common\Skyrim Special Edition\Papyrus Compiler\PapyrusCompiler.exe",
"flags":"TESV_Papyrus_Flags.flg",
"output": "C:\Program Files (x86)\Steam\steamapps\common\Skyrim Special Edition\Data\scripts",
"import": ["C:\Program Files (x86)\Steam\steamapps\common\Skyrim Special Edition\Data\source\scripts"],
"arguments": []
},
"fallout4":
{
"title": "Fallout 4",
"compiler": "",
"flags": "Institute_Papyrus_Flags.flg",
"output": "",
"import": [],
"arguments": []
}
}
}
EDIT :: Solved!
The pregiven files use "\" instead of "/" for filepaths. What a troll.
"compiler":"C:\\Steam\\steamapps\\common\\Skyrim Special Edition\\Papyrus Compiler\\PapyrusCompiler.Exe",
"flags":"TESV_Papyrus_Flags.flg",
"output": "",
"import":["C:\\Steam\\steamapps\\common\\skyrim\\Data\\Scripts\\Source",],
"arguments": []
This is my setting file, however when I try to compile a script it throws an error on my import setting. Im clueless, also. no settings works, even the default ones.
I got a message when trying to compile that the import path didn't exist, but it clearly did. I resolved this issue by actually saving the file before trying to compile it.
Now, I've found a problem with Skyrim scripts that write to properties in other scripts. Here is an example:
Actor npc = (DWFWashbasinMarkerRef as DWFWashbasinMarkerScript).currentUser
currentUser is an Actor property of DWFWashbasinMarkerScript, which is attached to DWFWashbasinMarkerRef (an ObjectReference property in this script). There are no problems, SublimePapyrus doesn't complain. However, if I try to write to the property instead of reading it:
(DWFWashbasinMarkerRef as DWFWashbasinMarkerScript).currentUser = None
This is valid syntax, compiles without error or warning, and works as intended. But in SublimePapyrus it gets marked as an error, saying: "The left-hand side expression contains operators other than the dot operator." Can you fix this?
for anyone confused, in SublimeText 2, in Preference > Browse Packages
it opens a window explorer (not an Open File Dialog), and navigates you to X:\Users\**YourName**\AppData\Roaming\Sublime Text 2\Packages
The installedPackages folder, in which you are looking for is one folder behind where you navigated initially, i.e. ...AppData\Roaming\Sublime Text 2
I also created a folder called Papyrus in the initial Packages folder and dropped the two package files in it as well, since it works fine, i just left it; although i doubt you have to do that.
I fairly new on scripting and sublime, so I guess this something happened, thanks to my lack of knowledge.
Right now, SublimePapyrus tells me, that the path for the compiler is undefined or invalid.
After using this guide here: https://github.com/Scrivener07/SublimePapyrus/blob/master/README.md#create-default-ini-file
I've learned that, I have to create a INI file, since I'm using a different installationpath. But my Sublime3 didn't know the command "create default INI file", after installing the packaged version. So I wrote one on my own.
[Skyrim]
scripts=D:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source
compiler=D:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Papyrus Compiler\PapyrusCompiler.exe
output=D:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts
workspace=D:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts
flags=TESV_Papyrus_Flags.flg
also I had to set the settings of the user preferences to a new folder, where I placed the .ini
{
"ini_path": "D:/SublimePapyrus.ini",
}
I have absolutly no clue what's going on here. I'm used to the CK, thats where I came from, I love to design questmods but the CK has its limits and I want to take the next step to integrate some new stuff in my work.
Hopefully that helps a bit.
Edit: Also, if you use Advanced Papyrus, you could point the path of the Papyrus compiler at the original Papyrus compiler, not the Advanced Papyrus wrapper. If you do not use Advanced Papyrus, then ignore this.
"compiler":"C:/Program Files (x86)/Steam/steamapps/common/Skyrim Special Edition/Papyrus Compiler/PapyrusCompiler.exe",
Be certain to use the correct slash "/", not "\". You also will want to set the "import": line to point to the appropriate script source folder, which in my case was:
"import": ["C:/Program Files (x86)/Steam/steamapps/common/Skyrim Special Edition/Data/Scripts/Source"],
I am not certain if the package is supposed to configure this automatically, and it just failed to do so in my case, or if a manual configuration is required for all users. I would note that I have both Skyrim and Skyrim Special Edition installed, and that everything works fine in terms of compiling and autocomplete with either when things are configured correctly.