DigitalPixel (talk | contribs) |
(updated with latest info / formatting) |
||
Line 9: | Line 9: | ||
}} | }} | ||
==Description== | ==Description== | ||
− | <font class="highlight"> | + | <font class="highlight">MQ2BardSwap</font> automatically swaps weapons with instruments as needed by bards. |
+ | |||
+ | ==Requirements== | ||
+ | <font class=''highlight''>MQ2BardSwap</font> needs any additional plugin loaded to support your configuration. Given the example INI at the bottom of this wiki, it uses /exchange. That would require you to load the [http://www.mmobugs.com/wiki/index.php?title=MQ2Exchange MQ2Exchange] plugin. If the command is built into base MQ (MQ2Main) or is an EverQuest command, then no additional plugins are needed. | ||
==Commands== | ==Commands== | ||
Line 18: | Line 21: | ||
==Example Usage== | ==Example Usage== | ||
− | Usage is simple, once you have your INI setup toggle the plugin on and it will start | + | Usage is simple, once you have your INI setup toggle the plugin on and it will start swapping instruments for the different types of songs. |
==Macro Data== | ==Macro Data== | ||
− | This plugin adds a new TLO | + | This plugin adds a new TLO. |
* <span class="highlight2">${BardSwap} : bool</span> - Returns true if bardswap is on, false if bardswap is off. | * <span class="highlight2">${BardSwap} : bool</span> - Returns true if bardswap is on, false if bardswap is off. | ||
− | === | + | ===TLO Members and Examples=== |
* <span class="highlight2">${BardSwap.Swapping} : bool</span> returns the status of swapping. | * <span class="highlight2">${BardSwap.Swapping} : bool</span> returns the status of swapping. | ||
− | * <span class="highlight2">${BardSwap.Excluded} : bool</span> | + | * <span class="highlight2">${BardSwap.Excluded} : bool</span> returns true/false based on if the current song is excluded from swapping logic |
− | * <span class="highlight2">${BardSwap.MeleeSwap} : bool</span> | + | * <span class="highlight2">${BardSwap.MeleeSwap} : bool</span> returns the status of Melee swapping. |
* <span class="highlight2">${BardSwap.Delay} : int</span> returns the melee swap delay as set in the ini. | * <span class="highlight2">${BardSwap.Delay} : int</span> returns the melee swap delay as set in the ini. | ||
− | * <span class="highlight2">${BardSwap.Casting} : string</span> returns the current spell/song being | + | * <span class="highlight2">${BardSwap.Casting} : string</span> returns the current spell/song being cast/sung. |
− | * <span class="highlight2">${BardSwap.CurrentSwap} : string</span> returns the name of currently swapped | + | * <span class="highlight2">${BardSwap.CurrentSwap} : string</span> returns the name of currently swapped instrument or weapon. |
===Example Usage=== | ===Example Usage=== | ||
− | Set your ini file up and toggle bardswap on with the toggle command listed above. The ini doesn't have to be exactly like the ini. The easiest way to think about it is | + | Set your ini file up and toggle bardswap on with the toggle command listed above. The ini doesn't have to be exactly like the example ini. The easiest way to think about it is, if a Stringed song is started to be sung the command listed in the ini file will execute. This can be an /exchange, /bandolier, /echo or any other number of commands. |
==Configuration== | ==Configuration== | ||
− | MQ2Bardswap | + | MQ2Bardswap configuration is read/written with the MQ2BardSwap_CharacterName_ServerName.ini file. If character named Bubba on Povar server, it would be: MQ2BardSwap_Bubba_Povar.ini |
===Sample Configuration=== | ===Sample Configuration=== | ||
− | |||
<pre>[Settings] | <pre>[Settings] | ||
Horn=/exchange "Trumpet of the Dragon Goddess" mainhand | Horn=/exchange "Trumpet of the Dragon Goddess" mainhand | ||
Line 53: | Line 55: | ||
[Exclude] | [Exclude] | ||
;Instruments don't have an effect on these | ;Instruments don't have an effect on these | ||
− | + | Exclude1=Requiem of Time | |
− | + | Exclude2=Selo's Rhythm of Speed | |
− | + | Exclude3=Selo`s Assonant Strane | |
− | + | Exclude4=Song of Sustenance | |
− | + | Exclude5=Alenia`s Disenchanting Melody | |
;no swap for my Selo's AA | ;no swap for my Selo's AA | ||
− | + | Exclude6=Selo`s Accelerating Chorus | |
;or lute of the flowing waters click | ;or lute of the flowing waters click | ||
− | + | Exclude7=Wind of Marr</pre> | |
===Configuration Explanation=== | ===Configuration Explanation=== | ||
− | * <span class="highlight2">Horn</span>: When you sing a brass instrument song this item will be | + | * <span class="highlight2">Horn</span>: When you sing a brass instrument song this item will be swapped to your mainhand slot before cast is up to get the extra boost from the item. |
− | * <span class="highlight2">Lute</span>: | + | * <span class="highlight2">Lute</span>: DISABLED means the plugin will not do any swapping if this type of song is played. |
* <span class="highlight2">Weapons</span>: This is the item to swap back to once the song has been sung. | * <span class="highlight2">Weapons</span>: This is the item to swap back to once the song has been sung. | ||
* <span class="highlight2">Exclude#</span>: If you want to exclude a specific song do so in the [Exclude] section of the ini file. | * <span class="highlight2">Exclude#</span>: If you want to exclude a specific song do so in the [Exclude] section of the ini file. |
Revision as of 16:35, 11 September 2015
Plugin Info | |
---|---|
Name | MQ2BardSwap |
Author | Cr4zyb4rd |
Link | Wiki Link |
Commands | /bardswap |
Source Available | Yes |
Uses INI File | Yes |
Contents
Description
MQ2BardSwap automatically swaps weapons with instruments as needed by bards.
Requirements
MQ2BardSwap needs any additional plugin loaded to support your configuration. Given the example INI at the bottom of this wiki, it uses /exchange. That would require you to load the MQ2Exchange plugin. If the command is built into base MQ (MQ2Main) or is an EverQuest command, then no additional plugins are needed.
Commands
- /bardswap Toggles swapping on/off.
- /bardswap melee Toggles melee swap delay on/off.
Example Usage
Usage is simple, once you have your INI setup toggle the plugin on and it will start swapping instruments for the different types of songs.
Macro Data
This plugin adds a new TLO.
- ${BardSwap} : bool - Returns true if bardswap is on, false if bardswap is off.
TLO Members and Examples
- ${BardSwap.Swapping} : bool returns the status of swapping.
- ${BardSwap.Excluded} : bool returns true/false based on if the current song is excluded from swapping logic
- ${BardSwap.MeleeSwap} : bool returns the status of Melee swapping.
- ${BardSwap.Delay} : int returns the melee swap delay as set in the ini.
- ${BardSwap.Casting} : string returns the current spell/song being cast/sung.
- ${BardSwap.CurrentSwap} : string returns the name of currently swapped instrument or weapon.
Example Usage
Set your ini file up and toggle bardswap on with the toggle command listed above. The ini doesn't have to be exactly like the example ini. The easiest way to think about it is, if a Stringed song is started to be sung the command listed in the ini file will execute. This can be an /exchange, /bandolier, /echo or any other number of commands.
Configuration
MQ2Bardswap configuration is read/written with the MQ2BardSwap_CharacterName_ServerName.ini file. If character named Bubba on Povar server, it would be: MQ2BardSwap_Bubba_Povar.ini
Sample Configuration
[Settings] Horn=/exchange "Trumpet of the Dragon Goddess" mainhand Drum=/exchange "Thunderous Drum of Karana" mainhand Lute=DISABLED Wind=DISABLED Singing=DISABLED Weapons=/exchange "Blade of Vesagran" mainhand Delay=21 [Exclude] ;Instruments don't have an effect on these Exclude1=Requiem of Time Exclude2=Selo's Rhythm of Speed Exclude3=Selo`s Assonant Strane Exclude4=Song of Sustenance Exclude5=Alenia`s Disenchanting Melody ;no swap for my Selo's AA Exclude6=Selo`s Accelerating Chorus ;or lute of the flowing waters click Exclude7=Wind of Marr
Configuration Explanation
- Horn: When you sing a brass instrument song this item will be swapped to your mainhand slot before cast is up to get the extra boost from the item.
- Lute: DISABLED means the plugin will not do any swapping if this type of song is played.
- Weapons: This is the item to swap back to once the song has been sung.
- Exclude#: If you want to exclude a specific song do so in the [Exclude] section of the ini file.
Version History
- 1.1 Cr4zyb4rd @ 2004-09-25
- Use spell structs instead of parsing MQ2Data complete rewrite of swapping logic, melee swapping should work in all situations
Availability
This plugin is included with the MMOBugs Compile.