DigitalPixel (talk | contribs) |
(→Sample Configuration: maxminutes) |
||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
{{Pluginbox | {{Pluginbox | ||
| name = MQ2AutoForage | | name = MQ2AutoForage | ||
| − | | author = Bling | + | | author = htw/Bling |
| link = [http://www.mmobugs.com/wiki Wiki Link] | | link = [http://www.mmobugs.com/wiki Wiki Link] | ||
| − | | commands= | + | | commands=/autoforage /startforage /stopforage /keepitem /destroyitem |
| source = Yes | | source = Yes | ||
| usesini = Yes | | usesini = Yes | ||
}} | }} | ||
==Description== | ==Description== | ||
| − | <font class="highlight">MQ2AutoForage</font> automatically uses the forage skill as well as automatically destroy foraged items that aren't wanted. | + | <font class="highlight">MQ2AutoForage</font> automatically uses the forage skill as well as automatically destroy foraged items that aren't wanted. You must have the Forage skill on a Ability Button (Alt-M, Abilities tab), for the plugin to operate correctly. |
==Commands== | ==Commands== | ||
| − | * <span class="highlight2">/startforage</span> Turns autoforaging on. | + | * <span class="highlight2">/startforage</span> Turns autoforaging on. Alias for: /autoforage start |
| − | * <span class="highlight2">/stopforage </span> Turns autoforaging off. | + | * <span class="highlight2">/stopforage </span> Turns autoforaging off. Alias for: /autoforage stop |
| − | * <span class="highlight2">/keepitem ''item''</span> Keeps foraged ''item'' automatically. | + | * <span class="highlight2">/keepitem ''item''</span> Keeps foraged ''item'' automatically. Alias for: /autoforage keep ''item'' |
| − | * <span class="highlight2">/destroyitem ''item''</span> Destroys foraged ''item'' automatically. | + | * <span class="highlight2">/destroyitem ''item''</span> Destroys foraged ''item'' automatically. Alias for: /autoforage destroy ''item'' |
| + | * <span class="highlight2">/autoforage</span> Displays current plugin settings. | ||
| + | * <span class="highlight2">/autoforage help</span> Displays the help info. | ||
| + | * <span class="highlight2">/autoforage max ##</span> Sets the max minutes to forage. (0=no max) | ||
| + | * <span class="highlight2">/autoforage auto off</span> Turns AutoStart off. | ||
| + | * <span class="highlight2">/autoforage auto on</span> Turns AutoStart on. | ||
| + | * <span class="highlight2">/autoforage tell off</span> Turns StopOnTell off. | ||
| + | * <span class="highlight2">/autoforage tell on</span> Turns StopOnTell on. | ||
| + | * <span class="highlight2">/autoforage hail off</span> Turns StopOnHail off. | ||
| + | * <span class="highlight2">/autoforage hail on</span> Turns StopOnHail on. | ||
| + | * <span class="highlight2">/autoforage afk off</span> Turns StopOnAFK off. | ||
| + | * <span class="highlight2">/autoforage afk on</span> Turns StopOnAFK on. | ||
| + | * <span class="highlight2">/autoforage gm off</span> Turns StopOnGM off. | ||
| + | * <span class="highlight2">/autoforage gm on</span> Turns StopOnGM on. | ||
| + | |||
| + | Using /keepitem or /destroyitem with an item on your cursor, will add that item name to the appropriate keep or destroy list. Otherwise, a name must be supplied, as shown in the above command list. | ||
==Example Usage== | ==Example Usage== | ||
* <span class="highlight2">/keepitem ''Tuft of Dire Wolf Fur''</span>: Would autoinventory any ''Tuft of Dire Wolf Furs'' foraged. | * <span class="highlight2">/keepitem ''Tuft of Dire Wolf Fur''</span>: Would autoinventory any ''Tuft of Dire Wolf Furs'' foraged. | ||
| − | * <span class="highlight2">/destroyitem ''Water | + | * <span class="highlight2">/destroyitem ''Water Flask''</span>: Would destroy any ''Water Flask'' that are foraged. |
| + | * <span class="highlight2">/autoforage hail on</span>: Turns on the option to stop foraging if you are hailed. | ||
| + | * <span class="highlight2">/autoforage max 600</span>: Sets the max time to forage to 600 minutes. | ||
==Configuration== | ==Configuration== | ||
| − | + | MQ2AutoForage provides configuration options in ServerName_CharacterName.ini (e.g., toon named Bubba on bertox would be bertox_Bubba.ini), in the [MQ2AutoForage] section. | |
===Sample Configuration=== | ===Sample Configuration=== | ||
| − | + | ServerName_CharacterName.ini | |
| − | <pre>[ | + | <pre>[MQ2AutoForage] |
AutoKeepAll=on | AutoKeepAll=on | ||
AutoAddAll=on | AutoAddAll=on | ||
AutoStart=off | AutoStart=off | ||
| − | + | StopOnHail=on | |
| − | + | StopOnTell=on | |
| − | + | StopOnAFK=off | |
| − | + | StopOnGM=on | |
| − | + | MaxMinutes=200 | |
| + | Plane of Growth_Tuft of Dire Wolf Fur=keep | ||
| + | Plane of Knowledge_Water Flask=destroy | ||
| + | Plane of Knowledge_Vegetables=destroy | ||
</pre> | </pre> | ||
===Configuration Explanation=== | ===Configuration Explanation=== | ||
| + | * <span class="highlight2">StopOnHail</span>: Turns off autoforage if someone hails you. | ||
| + | * <span class="highlight2">StopOnTell</span>: Turns off autoforage if someone sends you a tell. | ||
| + | * <span class="highlight2">StopOnAFK</span>: Turns off autoforage if you go AFK. | ||
| + | * <span class="highlight2">StopOnGM</span>: Turns off autoforage if a GM is detected. | ||
| + | * <span class="highlight2">MaxMinutes</span>: Max minutes to forage. | ||
* <span class="highlight2">AutoKeepAll</span>: AutoKeep all items foraged on/off, off will make the plugin check the ini to see if an item should be kept or destroyed. | * <span class="highlight2">AutoKeepAll</span>: AutoKeep all items foraged on/off, off will make the plugin check the ini to see if an item should be kept or destroyed. | ||
* <span class="highlight2">AutoAddAll</span>: AutoAdd items foraged to ini file on/off. | * <span class="highlight2">AutoAddAll</span>: AutoAdd items foraged to ini file on/off. | ||
* <span class="highlight2">AutoStart</span>: Automatically start foraging when able on/off. | * <span class="highlight2">AutoStart</span>: Automatically start foraging when able on/off. | ||
| − | * <span class="highlight2">[Zone]</span>: The clean name of the specific zone that you want items kept or destroyed (example [Guild Hall]). | + | * <span class="highlight2">[Zone]</span>: The clean name of the specific zone that you want items kept or destroyed (example [Guild Hall]), followed by _ and the item name. |
| − | * <span class="highlight2"> | + | * <span class="highlight2">Plane of Growth_Tuft of Dire Wolf Fur</span>: Keep any Tuft of Dire Wolf Fur. |
| − | * <span class="highlight2"> | + | * <span class="highlight2">Plane of Knowledge_Water Flask</span>: Destroy any Water Flask. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Availability== | ==Availability== | ||
This plugin is included with the MMOBugs Compile. | This plugin is included with the MMOBugs Compile. | ||
Latest revision as of 18:08, 31 January 2012
| Plugin Info | |
|---|---|
| Name | MQ2AutoForage |
| Author | htw/Bling |
| Link | Wiki Link |
| Commands | /autoforage /startforage /stopforage /keepitem /destroyitem |
| Source Available | Yes |
| Uses INI File | Yes |
Contents
Description
MQ2AutoForage automatically uses the forage skill as well as automatically destroy foraged items that aren't wanted. You must have the Forage skill on a Ability Button (Alt-M, Abilities tab), for the plugin to operate correctly.
Commands
- /startforage Turns autoforaging on. Alias for: /autoforage start
- /stopforage Turns autoforaging off. Alias for: /autoforage stop
- /keepitem item Keeps foraged item automatically. Alias for: /autoforage keep item
- /destroyitem item Destroys foraged item automatically. Alias for: /autoforage destroy item
- /autoforage Displays current plugin settings.
- /autoforage help Displays the help info.
- /autoforage max ## Sets the max minutes to forage. (0=no max)
- /autoforage auto off Turns AutoStart off.
- /autoforage auto on Turns AutoStart on.
- /autoforage tell off Turns StopOnTell off.
- /autoforage tell on Turns StopOnTell on.
- /autoforage hail off Turns StopOnHail off.
- /autoforage hail on Turns StopOnHail on.
- /autoforage afk off Turns StopOnAFK off.
- /autoforage afk on Turns StopOnAFK on.
- /autoforage gm off Turns StopOnGM off.
- /autoforage gm on Turns StopOnGM on.
Using /keepitem or /destroyitem with an item on your cursor, will add that item name to the appropriate keep or destroy list. Otherwise, a name must be supplied, as shown in the above command list.
Example Usage
- /keepitem Tuft of Dire Wolf Fur: Would autoinventory any Tuft of Dire Wolf Furs foraged.
- /destroyitem Water Flask: Would destroy any Water Flask that are foraged.
- /autoforage hail on: Turns on the option to stop foraging if you are hailed.
- /autoforage max 600: Sets the max time to forage to 600 minutes.
Configuration
MQ2AutoForage provides configuration options in ServerName_CharacterName.ini (e.g., toon named Bubba on bertox would be bertox_Bubba.ini), in the [MQ2AutoForage] section.
Sample Configuration
ServerName_CharacterName.ini
[MQ2AutoForage] AutoKeepAll=on AutoAddAll=on AutoStart=off StopOnHail=on StopOnTell=on StopOnAFK=off StopOnGM=on MaxMinutes=200 Plane of Growth_Tuft of Dire Wolf Fur=keep Plane of Knowledge_Water Flask=destroy Plane of Knowledge_Vegetables=destroy
Configuration Explanation
- StopOnHail: Turns off autoforage if someone hails you.
- StopOnTell: Turns off autoforage if someone sends you a tell.
- StopOnAFK: Turns off autoforage if you go AFK.
- StopOnGM: Turns off autoforage if a GM is detected.
- MaxMinutes: Max minutes to forage.
- AutoKeepAll: AutoKeep all items foraged on/off, off will make the plugin check the ini to see if an item should be kept or destroyed.
- AutoAddAll: AutoAdd items foraged to ini file on/off.
- AutoStart: Automatically start foraging when able on/off.
- [Zone]: The clean name of the specific zone that you want items kept or destroyed (example [Guild Hall]), followed by _ and the item name.
- Plane of Growth_Tuft of Dire Wolf Fur: Keep any Tuft of Dire Wolf Fur.
- Plane of Knowledge_Water Flask: Destroy any Water Flask.
Availability
This plugin is included with the MMOBugs Compile.