Cyotek Spriter HelpYou can configure external programs that you can run from the Tools menu.
About External Tools
An external tool is simply another program, such as Paint or Notepad that you can call directly from Spriter. The benefit of defining external tools is that you can specify the command lines to make some tasks easier, for example to open an image directly in Paint for editing. Leveraging the power of external command line utilities can greatly expand supported functionality.
Each external tool is comprised of five different options.
| Field | Description |
|---|---|
| Title | Specifies the title text that appears on the menu. You can use the ampersand (&) character in front of a letter to make it a keyboard accelerator. |
| Command | The path and filename of the command to execute. This field supports environment variables and application tokens. |
| Arguments | Specifies any custom arguments to pass to the command. This field supports environment variables and application tokens. |
| Initial Directory | Specifies the initial directory for the command. This field supports environment variables and application tokens. |
| Prompt for arguments | This option determines if the user is prompted for custom arguments when launching the tool. |
About Environment Variables
Environment variables are per-process variables provided by the operating system, and can be used to obtain the location of external tools or directories. To specify an environment variable, surround the variable name with percentage signs, for example %windir% or %TEMP%.
About Application Tokens
Application tokens allow you to inject information about the currently open document into the command lines for external tools. Application tokens consist of a keyword surrounded by brackets and a prefix character, for example $(ProjectPath).
| Token | Description |
|---|---|
$(AppPath) | The full path and executable name of the Spriter client |
$(AppDir) | The full directory name of the Spriter client |
$(AppFileName) | The name of the Spriter client executable |
$(AppName) | The name of the Spriter client executable, excluding the extension |
$(AppExt) | The extension of the Spriter client executable |
$(UserDataDir) | The full directory name of the Spriter user data folder |
$(ProjectPath) | The full path filename of the current project |
$(ProjectDir) | The full directory name of the current project |
$(ProjectFileName) | The name of the current project |
$(ProjectName) | The name of the current project, excluding the extension |
$(ProjectExt) | The extension of the current project |
$(SpritePath) | The full path filename of the sprite sheet |
$(SpriteDir) | The full directory name of the sprite sheet |
$(SpriteFileName) | The name of the sprite sheet |
$(SpriteName) | The name of the sprite sheet, excluding the extension |
$(SpriteExt) | The extension of the sprite sheet |
$(CssPath) | The full path filename of the style sheet |
$(CssDir) | The full directory name of the style sheet |
$(CssFileName) | The name of the style sheet |
$(CssName) | The name of the style sheet, excluding the extension |
$(CssExt) | The extension of the style sheet |
$(HtmlPath) | The full path filename of the HTML preview |
$(HtmlDir) | The full directory name of the HTML preview |
$(HtmlFileName) | The name of the HTML preview |
$(HtmlName) | The name of the HTML preview, excluding the extension |
$(HtmlExt) | The extension of the HTML preview |