Package Overview

Packages are a very important feature in TeSSH. They provide a way to bundle your settings and scripts and save them to a file or share them with other users.

Think of TeSSH Packages literally as a nicely wrapped package that you want to mail to another user. Inside the nicely wrapped package are all of the scripts (aliases, triggers, buttons, macros, etc) that you want to send.

Presumably you want to send this Package of scripts to another user because your scripts perform some sort of useful function. They might be a set of scripts for parsing a specific log file, or controlling a specific software system, or they might be a general purpose script for adding a new log window to an existing server session.

The main rule about Packages is that they should be self-contained. Advanced users can learn how to split functionality between multiple packages, but for most users, a package contains everything that it needs to perform it's function...all of the aliases, triggers, macros, etc.

As mentioned above, a Package is also a file stored on your computer's disk. Each package is stored in a file with the *.PKG file extension. Internally, these are SQLite3 database files. Each *.PKG file contains ONE package.

The default session package

When you create a new server session from the initial startup screen in TeSSH, a default package file is created for you. By default, TeSSH creates a subfolder with the name of the server you are playing, and in that subfolder it creates a *.PKG file with the same name as the folder.

For example, if you are creating a new character session on the "localhost" server, then the default package is stored in the "TeSSH\localhost\localhost.pkg" file.

As you use this server session, any aliases, triggers, macros, or other scripts that you create will be stored automatically in this package. You never need to specifically Save anything. TeSSH always keeps your package file up-to-date by saving in the background.

One of the main design goals with TeSSH was to eliminate any chance of losing any of your scripts. By storing your scripts in a database file (the package file) and keeping this file up-to-date in the background, TeSSH ensures that your settings are always saved in a standard format that is not likely to become corrupted. Even if your computer crashes or the power goes off, you will only lose a couple of minutes of work.

Changing your default session package

To determine where your session's default package is being stored, select the "Edit Session" action from the main TeSSH startup screen. Then click the Package Files tab. The Filename field at the top gives the name of your Package file. You can click the Browse button to open a different package file for this session, or just enter a new file name.

On this same screen you will see a list of "Packages". This allows you to load multiple package files into your session.

So you always have at least one package file loaded into your server session: the primary package listed in the FileName field. But a session can actually load as many different packages as you want.  This allows you to share common packages across multiple sessions.

Add comment

Login or register to post comments