Give Feedback
0 of 0
About this mod
Do you want to know which scripts use specific script objects? Do you want to know which scripts use specific Papyrus Functions? Do you want to know which scripts use specific Events? Do you want to create your own indexes of your own scripts? Do you want to search for values in scripts that I\'ve missed? When you read a script, would you lik
- Permissions and credits
Do you want to know which scripts use specific script objects?
Do you want to know which scripts use specific Papyrus Functions?
Do you want to know which scripts use specific Events?
Do you want to create your own indexes of your own scripts?
Do you want to search for values in scripts that I've missed?
When you read a script, would you like to be able to click on Script Objects, Papyrus Functions, and Script Events and be taken to the CreationKit Wiki Search page for that object?
This is my SkyrimScriptDumper. It's basically a VERY quick rehash of my Oblivion Script Dumper that I wrote....back in 2006. I _DID NOT_ fixup my sloppy code or what have you because I just wanted the functionality quick and dirty. But, I felt that the script samples on the wiki were... underwhelming.... when looking at specific functions, references, etc,. so what better way to see how to do it, than actually referencing the scripts that Bethesda wrote for the game.
REQUIREMENTS
=============
.Net 2.0
CreationKit installed (or at least the SOURCE script files)
NOTES ON USE
============
The cmdline is essentially:
SkyrimScriptDumper.exe "PATH TO SCRIPT FILES"
Sample:
SkyrimScriptDumper.exe "C:\Program Files(x86)\Steam\SteamApps\Common\Skyrim\Data\Scripts
\Source"
This will start parsing all the script files (.psc) in the source directory using the settings.xml file. It will create a Scripts subdirectory in whatever directory the .exe is running from. It will then create HTML files of all the scripts with hyperlinks to CreationKit wiki, and create Index files which link all the functions, script objects, events to the scripts that use them.
\Scripts\Scripts
\Scripts\Index-Events.htm
\Scripts\Index-Functions.htm
\Scripts\Index-ScriptObject.htm
\Scripts\stylesheet.css
Also, if you have a stylesheet named stylesheet.css in the SkyrimScriptDumper.exe folder location, it will copy that to the ,\scripts folder. A default one is included.
NOTES ON CUSTOMIZATION
======================
The dumper uses a settings.xml file which MUST be in the same directory as the SkyrimScriptDumper.exe. The file can be modified to suit your own needs.
A typical entry looks like the following:
<entry location="script" class="Events" type="general" url wiki="true">OnItemAdded</entry>
location: unused in this version. Please leage it set to "script".
Class: This is the class of object you're parsing for. All entries of the same class type will get their own index page with those items listed, and reference URLs to the scripts that use them. The naming is completely up to you.
url: Not used but eventually might be utilized to point to the WIKI location for this reference, or wherever you'd like to.
type: Not used, might eventually utilize this to group functions of script objects and whatnot together.
wiki: if true, this will create a hyperlink to the wiki site, for any occurrence of the entry in a script.
Do you want to know which scripts use specific Papyrus Functions?
Do you want to know which scripts use specific Events?
Do you want to create your own indexes of your own scripts?
Do you want to search for values in scripts that I've missed?
When you read a script, would you like to be able to click on Script Objects, Papyrus Functions, and Script Events and be taken to the CreationKit Wiki Search page for that object?
This is my SkyrimScriptDumper. It's basically a VERY quick rehash of my Oblivion Script Dumper that I wrote....back in 2006. I _DID NOT_ fixup my sloppy code or what have you because I just wanted the functionality quick and dirty. But, I felt that the script samples on the wiki were... underwhelming.... when looking at specific functions, references, etc,. so what better way to see how to do it, than actually referencing the scripts that Bethesda wrote for the game.
REQUIREMENTS
=============
.Net 2.0
CreationKit installed (or at least the SOURCE script files)
NOTES ON USE
============
The cmdline is essentially:
SkyrimScriptDumper.exe "PATH TO SCRIPT FILES"
Sample:
SkyrimScriptDumper.exe "C:\Program Files(x86)\Steam\SteamApps\Common\Skyrim\Data\Scripts
\Source"
This will start parsing all the script files (.psc) in the source directory using the settings.xml file. It will create a Scripts subdirectory in whatever directory the .exe is running from. It will then create HTML files of all the scripts with hyperlinks to CreationKit wiki, and create Index files which link all the functions, script objects, events to the scripts that use them.
\Scripts\Scripts
\Scripts\Index-Events.htm
\Scripts\Index-Functions.htm
\Scripts\Index-ScriptObject.htm
\Scripts\stylesheet.css
Also, if you have a stylesheet named stylesheet.css in the SkyrimScriptDumper.exe folder location, it will copy that to the ,\scripts folder. A default one is included.
NOTES ON CUSTOMIZATION
======================
The dumper uses a settings.xml file which MUST be in the same directory as the SkyrimScriptDumper.exe. The file can be modified to suit your own needs.
A typical entry looks like the following:
<entry location="script" class="Events" type="general" url wiki="true">OnItemAdded</entry>
location: unused in this version. Please leage it set to "script".
Class: This is the class of object you're parsing for. All entries of the same class type will get their own index page with those items listed, and reference URLs to the scripts that use them. The naming is completely up to you.
url: Not used but eventually might be utilized to point to the WIKI location for this reference, or wherever you'd like to.
type: Not used, might eventually utilize this to group functions of script objects and whatnot together.
wiki: if true, this will create a hyperlink to the wiki site, for any occurrence of the entry in a script.