Difference between revisions of "ISBoxer:Using ISBoxer Toolkit"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 144: Line 144:
  
 
== Window Layouts ==
 
== Window Layouts ==
; Swap Hot Character to main region
+
{| style="border:1px solid darkgray;margin:15px" rules="rows" cellpadding="5"
: If this box is ''not checked'', all windows become a "main" window. A main window will set the game's resolution in games that match the resolution to the size of the window. If it ''is'' checked, only one window at a time will be a main window, and all windows will run at the same resolution as the main window. Which window is main will be based on the Hot Character and determined by one of the options to the right. It is important to note that if this option is ''not'' checked, and the windows are different sizes, ''mouse repeat may be ineffective'', entirely due to the different window sizes.
+
!style="border:1px solid black;background:#ccffcc" colspan="2"| Window Layout Options
; always
+
|-
: The main window will ''always'' be the Hot Character
+
!width="200" align="left" | Swap Hot Character to main region
; when I press a Slot activate key
+
| If this box is ''not checked'', all windows become a "main" window. A main window will set the game's resolution in games that match the resolution to the size of the window. If it ''is'' checked, only one window at a time will be a main window, and all windows will run at the same resolution as the main window. Which window is main will be based on the Hot Character and determined by one of the options to the right. It is important to note that if this option is ''not'' checked, and the windows are different sizes, ''mouse repeat may be ineffective'', entirely due to the different window sizes.
: The main window will ''only'' be the Hot Character ''when a Slot activate hotkey'' is pressed -- as defined per Slot in the Character Set.
+
|-
; when I press ___
+
!width="200" align="left" | always
: The main window will ''only'' be the Hot Character when a specific hotkey is pressed -- as defined next to this option
+
| The main window will ''always'' be the Hot Character
 
+
|-
; Remove border around main window
+
!width="200" align="left" | when I press a Slot activate key
: Check this option to remove the border around the main window (or all of them, if Swap is unchecked). You do not need to use this option for World of Warcraft, which provides its own method of removing the border -- instead you can, in the game's Video, Resolution options, select Maximize and Disable Resize.
+
| The main window will ''only'' be the Hot Character ''when a Slot activate hotkey'' is pressed -- as defined per Slot in the Character Set.
; "Slave" regions Always On Top
+
|-
: This will cause non-main windows to have the Always On Top flag, meaning that they will appear on top of any window that does not have that flag (e.g. the main window, web browsers, etc). This option is therefore used to create the effect of '''Picture-in-Picture'''.
+
!width="200" align="left" | when I press ___
; Ignore next deactivate hotkey
+
| The main window will ''only'' be the Hot Character when a specific hotkey is pressed -- as defined next to this option
: Set this hotkey to provide a way to stop the current window from switching to a non-main position the next time it is deactivated. This can be used, for example, to switch to a web browser window without changing the main window. Note that if "Region 2 is used for session 2" in the Regions page, there is no need to use such a hotkey to switch to a web browser.
+
|-
; Wheel Switcher key
+
!width="200" align="left" | Remove border around main window
: This option sets a key that, while held, causes the Mouse Wheel to switch sessions. For example, if set to Ctrl, then holding Ctrl and scrolling the mouse wheel up will rotate through sessions in one direction, and scrolling down will rotate in the other direction.
+
| Check this option to remove the border around the main window (or all of them, if Swap is unchecked). You do not need to use this option for World of Warcraft, which provides its own method of removing the border -- instead you can, in the game's Video, Resolution options, select Maximize and Disable Resize.
; When clicking to focus a window, the game should
+
|-
: This option can be used to change the behavior of the initial click for the actual game, when clicking to focus a non-main window. Some games, such as EverQuest 2, will treat the click as if you meant to click on something in the game. Since this is not always the case, you may set this option to "ignore the click" to prevent the game from processing the click. Conversely, if the game ignores the click, and you do not want it to, this option can be set to "treat it like any other click", in which case the game will process the click. The default for this option is "do what it normally does", which does not change the game's behavior.
+
!width="200" align="left" | "Slave" regions Always On Top
 +
| This will cause non-main windows to have the Always On Top flag, meaning that they will appear on top of any window that does not have that flag (e.g. the main window, web browsers, etc). This option is therefore used to create the effect of '''Picture-in-Picture'''.
 +
|-
 +
!width="200" align="left" | Ignore next deactivate hotkey
 +
| Set this hotkey to provide a way to stop the current window from switching to a non-main position the next time it is deactivated. This can be used, for example, to switch to a web browser window without changing the main window. Note that if "Region 2 is used for session 2" in the Regions page, there is no need to use such a hotkey to switch to a web browser.
 +
|-
 +
!width="200" align="left" | Wheel Switcher key
 +
| This option sets a key that, while held, causes the Mouse Wheel to switch sessions. For example, if set to Ctrl, then holding Ctrl and scrolling the mouse wheel up will rotate through sessions in one direction, and scrolling down will rotate in the other direction.
 +
|-
 +
!width="200" align="left" | When clicking to focus a window, the game should
 +
| This option can be used to change the behavior of the initial click for the actual game, when clicking to focus a non-main window. Some games, such as EverQuest 2, will treat the click as if you meant to click on something in the game. Since this is not always the case, you may set this option to "ignore the click" to prevent the game from processing the click. Conversely, if the game ignores the click, and you do not want it to, this option can be set to "treat it like any other click", in which case the game will process the click. The default for this option is "do what it normally does", which does not change the game's behavior.
 +
|}
  
 
=== Rollover ===
 
=== Rollover ===

Latest revision as of 16:58, 14 April 2009

ISBoxer has a new home
The ISBoxer wiki on this site is no longer maintained.
Visit the official ISBoxer web site at ISBoxer.com
ISBoxer pages
Frequently Asked Questions
Getting started with ISBoxer Suite
KVM Mode
Repeater Regions
Types of Actions available for Mapped Keys
Using the ISBoxer Toolkit Interface
Using multiple computers
Videos
Fully functional WoW setup in 40 seconds
Creating your first team
ISBoxer Toolkit Overview Part 1
ISBoxer Toolkit Overview Part 2
Game-specific Information
Aion
EverQuest
EverQuest II
EVE Online
Lord of the Rings Online
World of Warcraft
more...
System Requirements
Windows 2000 or later, 32-bit or 64-bit
.NET Framework 2.0 or later
November 2008 or later update to DirectX

Using ISBoxer Toolkit

This page will provide a reference of all of the options in ISBoxer Toolkit, including how to use them and what effect they will have. For a complete guide to creating what you need through ISBoxer, see Getting started with ISBoxer Suite.

Providing this documentation takes time, so please bear with us as we construct the page.

ISBoxer

Auto-save on exit
Current File

Inner Space

Inner Space folder
Export all to Inner Space

Glossary

Character

Character Options
Actual Character name Set this option if the actual in-game name differs from what you named the Character in ISBoxer Toolkit. This is useful, for example, if you use the same name on multiple game servers. This option currently has no effect for games other than World of Warcraft, and then only if using a World of Warcraft Macro Action or a Generated Macro.
Game In order to launch the game when launching your desired Character Set, Inner Space will need to know what to launch. This drop-down box will be populated with the list of games configured in Inner Space.
Game Profile This drop-down box will be populated with the list of profiles configured in Inner Space for the selected Game. A Game may have any number of Game Profiles, which may indicate a different folder and/or executable for the Game.


Action Target Groups

Key Maps

Virtual Files

Virtualize as

Character Sets

Character Set Options
Launch one Character every ___ seconds This option sets the interval between Character launches. Using a longer interval may relieve some issues at startup, such as windows not properly moving to their non-main position defined by a Window Layout (a minor annoyance that can be solved by simply rotating through each of the windows). Some games also have a required launcher that can only be used for one instance at a time, in which case the launch interval should be long enough to navigate through the launcher and to the game. The default value for this option is 7 seconds, and can be as low as 4 seconds.
Prevent game from repositioning windows Certain games purposefully reposition the game window. Lord of the Rings Online, for example, will constantly try to center the game window. Checking this box will prevent that from happening. This is recommended for EverQuest 1 and Lord of the Rings Online.
Make game believe it is foreground window Some games will ignore input if they are not the active window. Checking this option will allow those games to process input when broadcast.
In-game ISBoxer GUI toggle hotkey (New in ISBoxer build 30) This option will toggle the in-game ISBoxer GUI, which allows you to click a button to reload ISBoxer settings (such as changes to Key Maps), and to configure regions of the screen which will automatically broadcast mouse movement and clicks to a desired Target.
Computer to launch on This option is for using multiple computers. When set, this Character Set will only appear on a given Computer, and may be launched on that Computer when a given Character Set is launched by setting Also Launch. See Using multiple computers.

Slots

Per slot

Slot Options
Hotkey to switch to this character Also referred to as Slot activate hotkey. Pressing this hotkey will focus the given Character's window, which may in turn cause the window to swap to the main region in the Window Layout.
CPU Cores If CPU Cores are not selected, the game will be in charge of setting the CPU Affinity. Otherwise, the affinity will be overridden using the selected cores.
World of Warcraft: FTL Modifiers FTL Modifiers are used for configuring "Focusless, Targetless, Leaderless" Macros (or just the Keystrokes) through ISBoxer. A different combination of Modifiers must be selected per Slot, in order to signal which Character is Hot. The sole purpose of this is to keep the Focus Target available for other purposes. If you do not use the Focus Target for anything else, it is recommended to use the Hot Character switch notifier instead.
Limit framerate in foreground to ___ This option will limit your framerate, given in Frames per Second (FPS), when this slot is the foreground window. By default, this is 60 FPS. This does not change in-game settings for games that have similar options -- for these games, the lower of the limits between ISBoxer and the game will probably take effect.
Limit framerate in background to ___ This option will limit your framerate, given in Frames per Second (FPS), when this slot is a background window. By default, this is 30 FPS. This does not change in-game settings for games that have similar options -- for these games, the lower of the limits between ISBoxer and the game will probably take effect.
Hot Character switch notifier

The Hot Character switch notifier is designed to make it easy to play as any Character in your Set, and have the others follow and assist that Character. Special options are provided that apply only to World of Warcraft, but similar functionality may be available in other games. World of Warcraft also has an alternative method to using the Hot Character switch notifier, being FTL Modifiers (explained elsewhere, link to be added here).

In a nutshell, the purpose of this functionality is to tell each Character which Character is Hot, so that they can properly follow and assist. This is done by broadcasting a different keystroke for each Character (if they all broadcast the same keystroke, there would be no way to identify which is which). The keystroke must then be interprted by the game by configuring a hotkey or macro via game-provided methods. World of Warcraft, for example, has a concept called the Focus Target, which is a secondary target that can be used for auto-follow, assist, and so on. The Focus Target would then be set to a given Character when the broadcast keystroke is received by the game, using a macro such as "/focus Bob" for a Character named Bob. Options are provided to generate such a WoW Macro automatically, so that you do not need to create any Macros yourself.

Hot Character switch notifier Options
Broadcast keystroke The keystroke to broadcast when switching to this Character
When above hotkey is pressed Select this option if you do not want the keystroke to broadcast when clicking on the window, using alt-tab, or any other method besides pressing the "Hotkey to switch to this character"
Any time I switch to this character Select this option if you want the keystroke broadcast any time you switch to the Character by any method, including clicking on the window, using alt-tab, the Hotkey to switch to the character, or otherwise.
World of Warcraft: Generate a Focus Target macro on this keystroke Select this option if you want ISBoxer to create a WoW Macro for you, bound to the broadcast keystroke, which will do /focus <Character>, in order to set the Focus Target for all Characters to the Hot Character (so that you can follow and assist the Hot Character any time you like)
World of Warcraft: Generate a Follow macro on this keystroke Select this option if you want ISBoxer to create a WoW Macro for you, bound to the broadcast keystroke, which will Follow the Hot Character, in order to have all Characters to automatically follow the Hot Character upon switching. If the Generate a Focus Target macro option is checked, the follow macro will be part of the Focus macro.

Key Maps

Window Layout

Repeater Profile

Also Launch

Key Maps

Key Map Options
Hold Mapped Keys while Hotkey is held This option sets the Default for any Mapped Keys in the Key Map. Mapped Keys may override the Default on an individual basis. See the Mapped Key equivalent for a description of this option.
Use FTL Modifiers This option sets the Default for any Mapped Keys in the Key Map. Mapped Keys may override the Default on an individual basis. See the Mapped Key equivalent for a description of this option.

Mapped Keys

Mapped Key Options
Hotkey This sets the key that you will actually press in order for this mapping to take effect. If it is set to F3, for example, then you would press F3 in order to activate the mapping.
Hold mapped keys while this hotkey is held This option, when enabled, will cause keystrokes to be held while the configured Hotkey is held. If not enabled, keystrokes will be quickly pressed and released at the time the Hotkey is released.
Use FTL Modifiers This option, when enabled, will cause keystrokes to also include the configured FTL Modifiers for the current Slot. For example, if Slot 1 is active, and is configured with Ctrl and Shift FTL Modifiers, any keystroke configured in this Mapped Key will also include Ctrl and Shift.
Send Next Click This option will cause Mouse Repeating to be temporarily enabled, to a selected Target, until you click or press the Hotkey again. This is very useful, for example, for casting Area Effect spells that require a ground target.

Steps

Actions

See Types of Actions

Character Sets

Characters

Window Layouts

Window Layout Options
Swap Hot Character to main region If this box is not checked, all windows become a "main" window. A main window will set the game's resolution in games that match the resolution to the size of the window. If it is checked, only one window at a time will be a main window, and all windows will run at the same resolution as the main window. Which window is main will be based on the Hot Character and determined by one of the options to the right. It is important to note that if this option is not checked, and the windows are different sizes, mouse repeat may be ineffective, entirely due to the different window sizes.
always The main window will always be the Hot Character
when I press a Slot activate key The main window will only be the Hot Character when a Slot activate hotkey is pressed -- as defined per Slot in the Character Set.
when I press ___ The main window will only be the Hot Character when a specific hotkey is pressed -- as defined next to this option
Remove border around main window Check this option to remove the border around the main window (or all of them, if Swap is unchecked). You do not need to use this option for World of Warcraft, which provides its own method of removing the border -- instead you can, in the game's Video, Resolution options, select Maximize and Disable Resize.
"Slave" regions Always On Top This will cause non-main windows to have the Always On Top flag, meaning that they will appear on top of any window that does not have that flag (e.g. the main window, web browsers, etc). This option is therefore used to create the effect of Picture-in-Picture.
Ignore next deactivate hotkey Set this hotkey to provide a way to stop the current window from switching to a non-main position the next time it is deactivated. This can be used, for example, to switch to a web browser window without changing the main window. Note that if "Region 2 is used for session 2" in the Regions page, there is no need to use such a hotkey to switch to a web browser.
Wheel Switcher key This option sets a key that, while held, causes the Mouse Wheel to switch sessions. For example, if set to Ctrl, then holding Ctrl and scrolling the mouse wheel up will rotate through sessions in one direction, and scrolling down will rotate in the other direction.
When clicking to focus a window, the game should This option can be used to change the behavior of the initial click for the actual game, when clicking to focus a non-main window. Some games, such as EverQuest 2, will treat the click as if you meant to click on something in the game. Since this is not always the case, you may set this option to "ignore the click" to prevent the game from processing the click. Conversely, if the game ignores the click, and you do not want it to, this option can be set to "treat it like any other click", in which case the game will process the click. The default for this option is "do what it normally does", which does not change the game's behavior.

Rollover

Enable Rollover zoom effect
Zoom scale
Roll up over time instead of instant zoom
Game frames to roll up

Regions

Position
Size
AutoLayout
Import
Computer
Region 2 is used for session 1 when inactive
Region 2 is used for session 2

Character Sets

Repeater Profiles

Show fake cursor in Repeater target windows when mouse repeat is enabled
Key repeat enabled
Mouse repeat enabled
Key repeat (indicator light)
Mouse repeat (indicator light)

Hotkeys

Toggle Keyboard repeating (Current Window)
Toggle Mouse repeating (Current Window)
Toggle Keyboard+Mouse repeating (Current Window)
Toggle Keyboard repeating (All Windows)
Toggle Mouse repeating (All Windows)
Toggle Keyboard+Mouse repeating (All Windows)

Whitelist/Blacklist

No White or Black list
White list - repeat keys ONLY if they are selected
Black list - repeat keys if they are NOT selected

Character Sets

Action Target Groups

Characters

Virtual Files

Characters

Virtualize as

Computers

If you are going to be multi-boxing with multiple Computers, you will need to define each Computer here (if not, you do not need to configure a Computer via ISBoxer Toolkit). This will set up the link between the Computers and allow configuration of all Computers in one place. After completing all configuration, you will need to copy the configuration to all of them, and Export to Inner Space.

To create a Computer, right click Computers and select New Computer. The New Computer will automatically be filled out with information for the current PC, and will name itself the name of the current PC if that name is not already used by a defined Computer.

IP Address or hostname
Inner Space Uplink Port
Inner Space Uplink Name
CPU Cores

See Using multiple computers

Screens

This is the Primary screen
Screen boundaries
Screen working area (maximized window)