[REL] Skyrim Script Dumper

[MofoMojo]

I wanted to announce the release of this utility.Think of it as a compliment to the Wiki site. I think there's no better way to learn how to use some of the things in Papyrus/Scripting than by example, and the best example I can think of are the ~10,000 scripts that Skyrim is comprised of...but...having any sense of what specific scripts use in the game or which scripts used which functions and events, and how...is terribly difficult in a flat file structure.

 

This tool will create an index of Events, Functions and ScriptObjects and HTML markup of ALL scripts, linking the indexes together, and also linking to CreationKit wiki GO/SEARCH.

 

Please take a look. It's based on my original Oblivion Script Dumper, which I am terribly ashamed of the code base for, but not enough to re-write it completely. I just wanted something quick and functional.

 

Utility found on the Nexus here.

 

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 Objects 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. 

Edited February 15, 2012 by MofoMojo

[Mansh00ter]

This will be *very* handy. Thanks a bunch!

[Cipscis]

I agree, thanks very much!

 

Cipscis

[GomuGomu64]

Freaking awesome. Totally what I needed! :D

[MofoMojo]

Thanks guys. I hope it will be of some use. I've uploaded a new settings.xml and a latest "pre-generated" script index based on those settings. They contain, from what I can tell, every Global and/or Member function in Papyrus and object types. I'm getting ready to upload a slightly newer version of the Script Dumper that changes the WIKI links to SEARCH instead of using the GO option, since some Script Objects share similar Function Names but might serve a slightly different purpose.

 

-MM

[schlusmans]

Hi MofoMojo,

This is really awesome! Thanks for this precious tool. I loved your Oblivion script dumper too :-)

Just a question: Is it also possible to dump esp files to psc files with this tool, as was the case with the Oblivion tool ? So far, I've only managed to dump Skyrim's original source files.