Miniwindow Basics - fiendish/aardwolfclientpackage GitHub Wiki
Ok. Let's cover this in two sections...
- The practical interaction with miniwindow plugins in the Aardwolf MUSHclient Package.
- A brief technical overview of what it means to call something a miniwindow.
Miniwindows in the Aardwolf MUSHclient Package
Miniwindows are graphical elements added to MUSHclient by scripts that mimic small floating windows that can be moved around the screen. In the Screen Reader version of the package, these are hidden so they don't get in the way.
Miniwindows in the package all share certain characteristics with each other.
Dragging/Moving
All of the miniwindows in this package can be moved around the screen, so that you can organize your layout any way you want.
http://www.aardwolf.com/play/screenshots.htm has many screenshots with examples of this.
In order to move the miniwindows around, find the part of the miniwindow where the mouse cursor changes to a hand and then click and drag. This part is either the entire miniwindow or a bar across the top if the rest of the area is used for other click actions. The hand looks like this: images/handcursor.png
Resizing
Nearly every miniwindow in this package is in some way resizable to your own preference by dragging the resize widget in the lower-right corner of the miniwindow. The resize widget looks something like this: images/resizer.png
When you move the mouse over the resize widget, the cursor will change to a pair of opposing diagonal arrows to indicate that the miniwindow can be resized by dragging there, like this: images/resizecursor.png
Right click Pop-up Menus
All of the miniwindows in this package have special menus that pop up when you right-click on them. These windows can contain configuration options and other commands that let you interact with the plugin in useful ways.
Here's just one example:
Controllable Z-order
Z-order is the order in which miniwindows are drawn on top of each other. In traditional coordinates, X is left/right, Y is up/down, and Z is in/out of the screen. A special feature in the plugins included in this package is the ability to make any of them jump in front of or behind all the others. In the example below, the player has the channel capture window hiding behind the ASCII map.
Selecting "Bring To Front" from the right-click menu on the channel capture window allows the player to switch the display order so that it gets shown on top. "Send To Back" (not shown) will do the reverse.
Lockable Layout
You can lock and unlock your miniwindow layout at any time. Read this for more information:
How do I lock/save/restore my layout?
Miniwindows: A Technical Overview
A "miniwindow" is the MUSHclient term for using a region of the screen for graphics, text, and mouse-event handlers that are technically part of but visually distinct from the main text output from the game.
Click here for an introduction to miniwindows
Miniwindows are not actually windows, though they can be made to behave like windows. They are in fact technically just elaborate blocks of pixels drawn on top of the main output area. The very first miniwindows were all stuck in place, fixed size, and nearly monochromatic. As time went on and developers got more used to the idea, we started inventing cool new features until eventually they started being less like fixed rectangular blocks and more like actual windows with intricate graphics and mouse event handlers. Advanced miniwindows today can simulate resizing and dragging and highlighting text, even though technically they are still just blocks of pixels pretending to be windows.
Easily Make Your Own Advanced Miniwindows
By taking advantage of a lot of pre-made magic invented for this package, making advanced miniwindows no longer takes a huge amount of work. Don't start from scratch like a rube. Instead, read the documentation for Easy DIY Miniwindows.