Tools

This directory contains legacy tools that support plug-in development. Plug-in development is generally more effective using the project system in recent versions of Strange Eons. These tools will likely be removed from a future version of the kit.

SE Text Resource Editor

The SE Text Resource Editor used to be the recommended editor when working with the text files used in SE, including settings files, UI strings, and JavaScript source files. However, code editing is now integrated into the Strange Eons project system. For most purposes, the integrated tools are better than the standalone editor and it is recommended to use them. However, the editor will still be included with this tool set until the integrated editing tools move to "stable" status. The editor is located in the se-resource-editor.jar JAR file. You can start the editor as you would run any JAR file. In addition, stub applications have been included for Windows to launch the editor (and plug-in bundler). To work, the stub applications must be in the same folder as the JAR file.

Command Reference

Plug-in Bundler

The plug-in bundler is part of the SE Text Resource Editor, but it can also be started as a separate application. To start the bundler's user interface, run the pack class in the JAR file using a command like java -cp se-resource-editor.jar pack. As with the editor, a stub Windows executable has been included that will launch the bundler for you. In addition to running the bundler in a window, you can also run it as a simple command line tool. The command line tool takes two or more arguments:

    pack [-z] directory bundle [files...]
where:
-z
creates a ZIP archive bundle instead of a Web-proof bundle
directory
is a base directory that will be used as the parent directory of the remaining arguments
bundle
is the name of the plug-in bundle file to create
files...
are zero or more files or directories to be included in the bundle
 

unjar

This is a simple command line tool for unpacking JAR files, ZIP archives, and SE plug-in bundles, available as both a Windows command line tool or a JAR file. Note that it does not unpack Web-safe bundles. To unpack a Web-safe bundle, first install the bundle as a plug-in in SE, then use unjar to unpack the installed version of the bundle. Usage:

    unjar [-nogui] archive.jar directory
where:
-nogui
will suppress the progress bar and Cancel button that are normally shown.
archive.jar
is the name of the archive to be unpacked
directory
is the directory where the archive will be unpacked. It will be created if it does not exist.

Other Tools

In addition to the tools provided in this folder, there are some additional tools built into Strange Eons itself. The MakeDocs tool generates documentation from JavaScript source files. The Resource Tool can be used to create a copy of all of the standard images and text files that come with SE, to serve as a basis for writing extensions. If you selected the "Download and Install Latest Plug-in Authoring Kit" from the Windows installer when installing SE, and you asked for Start Menu short cuts, you will have a short cut to start the Resource Tool in your Start Menu. You can also start it using the -restool option on the SE command line, or by starting SE with Caps Lock activated. (The Caps Lock state cannot be detected under OS X, so this doesn't work on Macs.)

See Also

The MakeDocs Tool
The Quickscript Window
Editor Command Reference
 

Documentation Index