Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Most HSL scripts are created using the Shogun Post Script Editor.
    • The easiest way to create an HSL script is to open the Script Editor (see Open the Script Editor), click Record Actions Image Modified, then perform one or more actions in Shogun. When you are done you can click Record Actions again to stop recording. When the steps are recorded, you can execute them by clicking Run Script Image Modified, or customize them to create a more full-featured script.

    • The Script Editor features tools for editing scripts, debugging scripts, saving scripts and loading previously saved scripts. For more information, see Use the Shogun Post Script Editor.
  • You can use any ASCII text editor to create scripts as long as that editor uses only standard ASCII characters. Note that although you can create cancreate ASCII files with Microsoft® Word and WordPad, they frequently insert nonstandard characters like em-dashes and "curly" quotes, which Shogun cannot read.
  • Sometimes you want to create scripts that prompts the user for information. You can do this in the following ways:
    • Create a user window that collects information which is subsequently passed to a script (see Create user windows to run HSL scripts).
    • Create a pipeline operation. A pipeline operation is just a script with extra statements that ask the user to provide information prior to execution. You can string together multiple pipeline operations to create very sophisticated routines.

...

  • The Log displays a list of all the commands you have executed in the current session. To display the Log, either:
    • On the status bar, click the Log button.

      Image Modified

      or
    • On the General menu, click Log.
      The Log displays a list of previously executed commands. This is useful when you want to see the results of previous commands while writing a script.
  • You can also use the print command to write the contents of specified strings to the Log (see Print HSL command data to Log).

...

Scroll only

About Vicon Shogun documentation

The following documentation is available with Shogun, both as help pages available online and as PDFs that you can download from docs.vicon.com:

30%, 70%

DocumentDescription
What's New in sNewin Vicon ShogunDescribes new features in the latest release.
Installing and licensing Vicon ShogunInstallation and licensing instructions.
Getting started with Vicon Shogun
Basic information on an end-to-end workflow for capturing data with Vicon Shogun Live and processing and exporting it with Vicon Shogun Post.
Getting more from Vicon ShogunMore advanced information to help you to take your use of Shogun further, for example, to add your own customizations, or to automate capture.
HSL scripting with Vicon Shogun
HSL scripting guidelines and commands.
Python scripting with Vicon ShogunBasic information on using Python with Shogun.
Getting started with Vicon RetargetBasic information on using Vicon's retargeting application.

For more documentation related to Shogun and other Vicon documents, visit docs.vicon.com.