/ArmaScriptTrace

Parse Arma2/3 script files and display call graph.

Primary LanguageJavaGNU General Public License v3.0GPL-3.0

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>ArmaScriptTrace ReadMe</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">

</head>
<body>

<center>
<h1>ArmaScriptTrace ReadMe</h1>
</center>

<h2>Contents</h2>
<ul>
<li><a href="#intro">Introduction</a></li>
<li><a href="#systemreqs">System Requirements</a></li>
<li><a href="#howto">How To Use ArmaScriptTrace</a></li>
<li><a href="#known_issues">Known Issues</a></li>
<li><a href="#changelog">Changelog</a></li>
<li><a href="#license">License</a></li>
<li><a href="#thanks">Thanks To</a></li>
</ul>


<a name="intro"><h2>Introduction</h2></a>

<p>ArmaScriptTrace provides the ability to parse Arma2 script files and display an image of the calls to other scripts.
It will follow <a href="http://community.bistudio.com/wiki/execFSM">execfsm</a>, <a href="http://community.bistudio.com/wiki/preprocessFileLineNumbers">preprocessfilelinenumbers</a>, 
<a href="http://community.bistudio.com/wiki/addAction">addaction</a>, 
<a href="http://community.bistudio.com/wiki/preprocessFile">preprocessfile</a>, <a href="http://community.bistudio.com/wiki/execVM">execvm</a>,
and #include calls.</p>

Supported Filetypes:
<ul>
<li>.sqf</li>
<li>.sqs</li>
<li>.ext</li>
<li>.sqm</li>
<li>.hpp</li>
<li>.fsm</li>
<li>.h</li>
<li>.cpp</li>
</ul>

<a name="systemreqs"><h2>System Requirements</h2></a>

<ul>
<li><a href="http://www.java.com/en/download/index.jsp">Java Runtime Environment</a></li>
</ul>

<a name="howto"><h2>How To Use ArmaScriptTrace</h2></a>

<ul>
<li>Double click the .jar file (or the batch file) to open the application.</li>
<li>Click the file menu and open a script file, or alternatively, drag and drop scripts onto the main window.</li>
<li>Optionally, save the resulting image on your computer.</li>
</ul>

<a name="known_issues"><h2>Known Issues</h2></a>

<p>No known issues.</p>


<a name="changelog"><h2>Changelog</h2></a>

<ul>
<li>Version 0.5
	<ul>
		<li></li>
	</ul>
</li>
<li>Version 0.4
	<ul>
		<li>scrollPane resizes after loading multiple files (this was fixed by creating multiple image files)</li>
		<li>Add ability to set tree or cluster mode for the resulting graphics file</li>
		<li>Add ability to drag and drop files onto the main window to load scripts</li>
		<li>Add ability to save images to PNG, JPG, and PDF</li>
		<li>Default save location to Desktop</li>
		<li>Add ability to filter by filetype</li>
		<li>Add ability to filter by method calls</li>
		<li>Fixed some bugs, restructured the dot generator a little</li>
		<li>Open menu item disabled while processing script</li>
		<li>Delete image and dot files on run just in case there are leftovers from previous run</li>
		<li>Check file size of resulting image to see if GraphViz worked correctly, if not display error message</li>
	</ul>
</li>
<li>Version 0.25
	<ul>
		<li>Prevented loops from making the program hang</li>
		<li>Add grab and pan image</li>
		<li>Add loading progress bar screen while parsing scripts</li>
	</ul>
</li>
<li>Version 0.2
	<ul>
		<li>Fixed some problems with quotations</li>
		<li>Asks if you want to load more files if you're loading a mission</li>
		<li>Added support for more filetypes</li>
		<li>Added support for execfsm, preprocessfilelinenumbers. and addaction</li>
	</ul>
</li>
<li>Version 0.11
	<ul>
		<li>Fixed missing zlib1.dll</li>
		<li>Improved documentation</li>
		<li>Added batch file</li>
	</ul>
</li>
<li>Version 0.1
	<ul>
		<li>Initial release</li>
	</ul>
</li>
</ul>

<a name="license"><h2>License</h2></a>

<p>ArmaScriptTrace is licensed under the <a href="license.txt">GPL version 3</a>.  To view the sourcecode, please see the "src" directory.</p>
<p>GraphViz is licensed under the <a href="http://www.graphviz.org/License.php">Common Public License version 1.0</a>.  The binaries and dll files for GraphViz were
provided from their website.  Certain sections of GraphViz were removed to reduce size.</p>

<a name="thanks"><h2>Thanks To</h2></a>

<ul>
<li>Thank you to Gnome, Rob, Buehgler and all the guys over at <a href="http://www.alphasquad.net">AlphaSquad</a>.</li>
<li>Thanks to all the testers (kju, etc.)</li>
<li>Thanks to SickBoy for providing development space on <a href="http://www.dev-heaven.net">Dev-Heaven</a>.</li>
<li>BIS for creating an awesome game and staying true to the community.</li>
<li><a href="http://www.graphviz.org">GraphViz</a>, for without them, this app would not be possible.</li>
<li><a href="http://iharder.sourceforge.net/current/java/filedrop/">Java FileDrop</a>, for the nice library and for releasing it under the public domain.</li>
</ul>

</body>
</html>