Documentation

Terminology

It's important to use the correct terminology when talking about package editing. Here's a quick guide to the different sections of the package editor and what they represent:

Packages

The tabs across the top of the editor (except All) represent the package files you have loaded. The All tab will display the contents of every package all together.

All your settings in a package (tab) must be within a module or window. If you have anything except modules or windows in the root of your package, your package has become corrupt. A number of things can cause this, chiefly bugs in beta versions. If you can narrow down the source of the corruption, please post a bug report on the forums.

Modules

Modules are represented in the editor by yellow capsule icons, sometimes with blue arrows on them. They should always be at the root of the package, never inside another module or window.

Modules can contain any type of setting, and can be configured to be visible only to other settings in the same package, to all settings, or only to settings outside its package. More information on modules is here.

Windows

Windows are represented by a blue window icon. Windows are like modules in that they must be within the root of the package and contain other settings. Windows also include a GUI component that lets them display things, have network connections, and so on.

Settings inside windows are never visible to anything outside that window. Don't store variables in a window that you want to be visible outside that window - create a module in the same package as the window and use whichever of the local and global options is appropriate.

Add comment

Login or register to post comments