Difference between revisions of "IS:Repeater"
Line 10: | Line 10: | ||
* When '''mouse repeating''' is enabled: | * When '''mouse repeating''' is enabled: | ||
** '''Duplicates mouse clicks''' at the same position in all other open sessions | ** '''Duplicates mouse clicks''' at the same position in all other open sessions | ||
+ | ** '''Duplicates mouse wheel movement''' if used with Inner Space build 4751 or later (currently a "development build" that can be switched to by checking the "Download development (test) builds" box in the IS patcher window, and then ''restarting'' Inner Space) | ||
** While holding left or right mouse buttons, '''relative mouse movement''' is also repeated in all other open sessions | ** While holding left or right mouse buttons, '''relative mouse movement''' is also repeated in all other open sessions | ||
* Supports '''any number of key lists''', any of which can be used as a '''whitelist or blacklist''' | * Supports '''any number of key lists''', any of which can be used as a '''whitelist or blacklist''' | ||
Line 90: | Line 91: | ||
== Release history == | == Release history == | ||
+ | * 2008-11-01 (To download this specific version: [http://www.lavishsoft.com/downloads/mods/repeater-20081101.zip repeater-20081101.zip]) | ||
+ | ** Mouse repeater now includes mouse wheel when used with Inner Space build 4751 or later | ||
* 2008-10-29 (To download this specific version: [http://www.lavishsoft.com/downloads/mods/repeater-20081029.zip repeater-20081029.zip]) | * 2008-10-29 (To download this specific version: [http://www.lavishsoft.com/downloads/mods/repeater-20081029.zip repeater-20081029.zip]) | ||
** Separated mouse and key repeater functionality | ** Separated mouse and key repeater functionality |
Revision as of 05:37, 1 November 2008
Contents
What is Repeater?
Repeater is an open source key repeater solution for Inner Space. Enable the repeater by pressing one key, then perform any mouse clicks or keys that should be duplicated in all other sessions, and disable by pressing the same key used to enable.
Future versions or custom modifications could include an on-screen indicator when repeating is enabled.
Features
- Includes a bind to turn repeating functionality on or off
- When keystroke repeating is enabled:
- Duplicates keystrokes in all other open sessions
- When mouse repeating is enabled:
- Duplicates mouse clicks at the same position in all other open sessions
- Duplicates mouse wheel movement if used with Inner Space build 4751 or later (currently a "development build" that can be switched to by checking the "Download development (test) builds" box in the IS patcher window, and then restarting Inner Space)
- While holding left or right mouse buttons, relative mouse movement is also repeated in all other open sessions
- Supports any number of key lists, any of which can be used as a whitelist or blacklist
- By default, "repeater lists.xml" will be imported. Any number of XML settings files may be imported while Repeater is running.
Installing Repeater
- Make sure you have Inner Space build 4735 or later (you can hover your mouse over the icon in the system tray to find out)
- Download the latest version: repeater-20081029.zip
- Extract to the Scripts folder of your Inner Space installation
Launching Repeater
- Per Inner Space session you want to be able to use repeater from
run repeater <key>
... where <key> is the name of the key or a key combination to use to enable or disable repeating. If no key is given, it will default to the MR key (available on G11/G15 keyboards) Examples:
run repeater F12 run repeater "scroll lock" run repeater "ctrl+scroll lock"
Key lists
Example 1
- This XML could be saved as "repeater lists.xml" in the Scripts folder (where Repeater is installed to), to be automatically loaded, or saved as another XML file to be manually loaded. It adds two different key lists -- esdf and wasd. The repeater command can be used to select either as a white list or black list, once loaded.
<?xml version='1.0' encoding='UTF-8'?> <InnerSpaceSettings> <Set Name="esdf"> <Setting Name="e" /> <Setting Name="s" /> <Setting Name="d" /> <Setting Name="f" /> </Set> <Set Name="wasd"> <Setting Name="w" /> <Setting Name="a" /> <Setting Name="s" /> <Setting Name="d" /> </Set> </InnerSpaceSettings>
Commands
Repeater
The repeater command provided by Repeater is the intended method for interacting with or configuring Repeater while it is loaded. It accepts any number of the following parameters in any order (but will be applied left to right):
- import <filename>: Imports an XML settings file of the proper format (such as in Example 1), to add key lists. Note: if the lists were previously imported, the new lists will be merged with the old lists.
- export <filename>: Exports all loaded key lists into a given XML settings file (overwrites this file, use with care!)
- whitelist <key list name>: Selects a key list to be used as a whitelist. Only the keys in this list will be repeated. If a previous white or black list was set, that list is overridden with this new behavior.
- blacklist <key list name>: Selects a key list to be used as a blacklist. Only the keys that do NOT appear in this list will be repeated. If a previous white or black list was set, that list is overridden with this new behavior.
- removelist <key list name>: Removes a key list from the loaded key lists.
- nolist: Designates that there is no longer a white or black list in use. If a white or black list was set, that list is overridden with this new behavior.
- on: Turns ON both key and mouse repeating functionality
- off: Turns OFF both key and mouse repeating functionality
- toggle: TOGGLES both key and mouse repeating functionality (Note: if one was off and the other was on, the "one" will now be on, and "the other" will now be off)
- mouseon: Turns ON mouse repeating functionality
- mouseoff: Turns OFF mouse repeating functionality
- mousetoggle: TOGGLES mouse repeating functionality
- keyon: Turns ON key repeating functionality
- keyoff: Turns OFF key repeating functionality
- keytoggle: TOGGLES key repeating functionality
Examples
- Import an XML file containing key lists
repeater import "My Key Lists.xml"
- Export all loaded key lists
repeater export "All key lists.xml"
- Use a particular already-loaded key list as the whitelist
repeater whitelist "esdf"
- Use a particular already-loaded key list as the blacklist
repeater blacklist "wasd"
- Un-set the current white or black list
repeater nolist
- Toggle mouse repeating
repeater mousetoggle
- Toggle key repeating
repeater keytoggle
- Set a whitelist and toggle key repeating
repeater whitelist "esdf" keytoggle
- Clear the white or black list and toggle key repeating
repeater nolist keytoggle
- Remove a specific list and re-import an XML (note: XML files can have any number of lists)
repeater removelist "movement keys" import "movement keys.xml"
Release history
- 2008-11-01 (To download this specific version: repeater-20081101.zip)
- Mouse repeater now includes mouse wheel when used with Inner Space build 4751 or later
- 2008-10-29 (To download this specific version: repeater-20081029.zip)
- Separated mouse and key repeater functionality
- Implemented whitelist and blacklist functionality. Any number of key lists can be imported from any number of XML setting files. A black OR white list can be used (but not both at the same time), and any list may be used as either a black or white list.
- 2008-10-25 (To download this specific version: repeater-20081025.zip)
- With Inner Space build 4735 or later, Repeater now has improved mouselook support. ${Mouse.Cursor} is used to determine if the cursor is visible -- if not, the absolute mouse position will not be relayed. Additionally, while the left or right mouse button is held down, relative mouse positions will be relayed.
- Repeating clicking on a non-UI portion of a World of Warcraft window should no longer mess up the camera, thanks to the above change. The same should be true in other games that have a similar control style, since this is not specificlaly for World of Warcraft.
Join us on IRC
We are on irc.lavishsoft.com in channel #isboxer, the best place to talk about and get help with all of the tools for multi-boxing with Inner Space! Whether you are already using it, or just have some questions for people who are, please feel free to stop by.
If you do not know how to join IRC, click here to join us via your browser!