SolarStrike wiki - User contributions [en]

RoM Configuration

2009-10-14T23:31:33Z

95.115.30.244: /* Expert Profile - Options */

There are two main settings files for RoM bot: settings.xml and your profile.
Profiles contain character-specific settings, while settings.xml contains hotkey settings and general preferences.

== Settings.xml ==
Here is an example settings file:
<source lang="xml">
<settings>
<hotkeys>

<hotkey description="MOVE_FORWARD" key="VK_W" modifier="" />
<hotkey description="MOVE_BACKWARD" key="VK_S" modifier="" />
<hotkey description="ROTATE_LEFT" key="VK_A" modifier="" />
<hotkey description="ROTATE_RIGHT" key="VK_D" modifier="" />
<hotkey description="STRAFF_LEFT" key="VK_Q" modifier="" />
<hotkey description="STRAFF_RIGHT" key="VK_E" modifier="" />
<hotkey description="JUMP" key="VK_SPACE" modifier="" />

<hotkey description="TARGET" key="VK_TAB" modifier="" />
<hotkey description="TARGET_FRIEND" key="VK_J" modifier="" />
</hotkeys>

<options>
<option name="ENABLE_FIGHT_SLOW_TURN" value="false" />
<option name="MELEE_DISTANCE" value="45" />
<option name="LANGUAGE" value="english" />
<option name="DEBUGGING" value="true" />
</options>
</settings>
</source>

===Settings - Hotkeys===
The hotkey settings are mostly self-explanatory. MOVE_FORWARD, obviously, coresponds to the key that makes your character walk forward. This is "W" by default. Note that '''all''' keys must preceeded by 'VK_'.

You may also notice the 'modifier'. Modifiers are keys such as CONTROL, SHIFT, or ALT. However, be aware that modifiers currently '''do not work'''. You should not set modifiers or you may run into problems. Instead, just leave the modifier set to an empty string("").

If your Runes of Magic bindings file (By default, is located at 'My Documents/Runes of Magic/bindings.txt') can be found and loaded, the RoM bot will instead use these settings so that you will not need to manually change your hotkey settings.

===Settings - Options===
{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | ENABLE_FIGHT_SLOW_TURN
| style="border-bottom:1px dotted #000000;" | Allows you to enable or disable "slow turning" in combat. If you have click-to-move on, you should not need this. It should be set to either "true" or "false". The default is "false".
|-
| style="border-bottom:1px dotted #000000;" | MELEE_DISTANCE
| style="border-bottom:1px dotted #000000;" | The distance at which to conduct melee combat. A value of 45 is good and should not be changed unless you have problems with being either too close or too far away for melee combat. Default: "45".
|-
| style="border-bottom:1px dotted #000000;" | LANGUAGE
| style="border-bottom:1px dotted #000000;" | Allows you to set your prefered language. Acceptable values are "english", "deutsch", , "russian" and "french".
|-
| style="border-bottom:1px dotted #000000;" | USE_CLIENT_LANGUAGE
| style="border-bottom:1px dotted #000000;" | After loading the bot, we will automaticly use the game clients language as bot language.
|-
| style="border-bottom:1px dotted #000000;" | DEBUGGING
| style="border-bottom:1px dotted #000000;" | This is a debugging option. When set to true, it will instantly exit on memory read errors and provide better debugging information. Default: "false".
|}

== Character Profiles ==
There are a few things you should know about character profiles first:
* They typically are named after the character that will use them
* They must be inside the 'rom/profiles' folder
* They must follow proper XML formatting
* They may contain custom Lua code

There are many profile options that can be set so it is highly recommended you make a copy of the default profile (Default.xml) and modify that to your character's needs instead of starting from scratch.

'''If you have extension hiding turned off,''' the .xml extension will not show on any of your files. If this is the case, '''do not''' add the .xml extension or you will end up with a file named something like Default.xml.xml. This may cause the profile to not be found and you may get errors. However, if you are able to see extensions, you should of course include the .xml extension when naming your profile.

===Profile - Options===

<source lang="lua"><options>
<option name="HP_LOW" value="85" />
<option name="MP_LOW_POTION" value="50" />
<option name="HP_LOW_POTION" value="40" />
...
</source>

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Healing and Potions'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HP_LOW
| style="border-bottom:1px dotted #000000;" | The percentage of health to use heal skills at
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HP_LOW_POTION
| style="border-bottom:1px dotted #000000;" | The percentage of health to use potions at
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MP_LOW_POTION
| style="border-bottom:1px dotted #000000;" | The percentage of mana to use mana potions at
|}

{|
| style="background-color: #C0C0FF; text-align: center;" | '''Combat Options'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | COMBAT_TYPE
| style="border-bottom:1px dotted #000000;" | Either "melee" or "ranged". Whichever best fits your character. Default: empty string (""). When unset (default), it will determine this automatically based on your class. There is no need to change this.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | COMBAT_RANGED_PULL
| style="border-bottom:1px dotted #000000;" | Whether or not to attempt to "pull" enemies towards you with ranged skills while you are a melee-based class
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | COMBAT_DISTANCE
| style="border-bottom:1px dotted #000000;" | The distance to remain at when fighting. This only affects your character when COMBAT_TYPE is "ranged" or when you use COMBAT_RANGED_PULL as melee.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MAX_FIGHT_TIME
| style="border-bottom:1px dotted #000000;" | If you stop damaging a target within this amount of time, you will skip this target (prevents getting stuck).
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | DOT_PERCENT
| style="border-bottom:1px dotted #000000;" | Only use DOTs on this target if it has more than this percentage of HP.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | ANTI_KS
| style="border-bottom:1px dotted #000000;" | Whether or not to avoid stealing other players' kills. true or false.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Waypoint and Movement'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | WAYPOINTS
| style="border-bottom:1px dotted #000000;" | The filename (including .xml extension) of the waypoint script to use. Must reside in the 'waypoints' folder!
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | RETURNPATH
| style="border-bottom:1px dotted #000000;" | The filename (including .xml extension) of the waypoint script to use for returning after death. Must reside in the 'waypoints' folder!
|-

| style="width: 200px; border-bottom:1px dotted #000000;" | PATH_TYPE
| style="border-bottom:1px dotted #000000;" | The type of movement to use. Should be either 'waypoints' or 'wander'. See path types for more information.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | WANDER_RADIUS
| style="border-bottom:1px dotted #000000;" | The distance that your character is allowed to "wander" freely when using wander mode.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | WAYPOINT_DEVIATION
| style="border-bottom:1px dotted #000000;" | A 'random' offset applied to each waypoint in your path giving it less of a bot-like appearance; suggested value of 50. Lower value means you stick closer to your normal path; 0 means no deviation.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | QUICK_TURN
| style="border-bottom:1px dotted #000000;" | Whether or not to use quick turn mode. Quick turn mode emulates a click-to-move type movement style. This means your character does not stop to slowly turn around.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Level Difference'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | TARGET_LEVELDIF_ABOVE
| style="border-bottom:1px dotted #000000;" | The maximum level of enemy above your own to engage in combat. i.e. a value of 5 means you will attack monsters up to 5 levels above your own.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | TARGET_LEVELDIF_BELOW
| style="border-bottom:1px dotted #000000;" | The maximum level of enemy below your own to engage in combat. i.e. a value of 5 means you will attack monsters up to 5 levels below your own.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Looting'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT
| style="border-bottom:1px dotted #000000;" | Whether you want to loot enemies or not. True or false.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT_IN_COMBAT
| style="border-bottom:1px dotted #000000;" | Whether or not you want to pick up loot when other enemies are still attacking you.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT_DISTANCE
| style="border-bottom:1px dotted #000000;" | The max distance away a corpse can be that you will attempt to loot.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT_PAUSE_AFTER
| style="border-bottom:1px dotted #000000;" | A percentage probability to attempt a short "rest" (to look more human) after looting an enemy.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Resting'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HP_REST
| style="border-bottom:1px dotted #000000;" | If health falls below this percentage, then rest.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MP_LOW
| style="border-bottom:1px dotted #000000;" | If mana falls below this percentage, then rest.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Log out & Resurrection Settings'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_TIME
| style="border-bottom:1px dotted #000000;" | Log out after this amount of time (in minutes). A value of 0 means you will not use this setting. Default: 0
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_SHUTDOWN
| style="border-bottom:1px dotted #000000;" | If you want to have the computer automatically shutdown after automatically logging out. Default: false
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_WHEN_STUCK
| style="border-bottom:1px dotted #000000;" | If your character gets stuck and cannot unstuck himself, you can use this option to have him log off. Default: true
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_SHUTDOWN
| style="border-bottom:1px dotted #000000;" | If you want to have the computer automatically shutdown after automatically logging out. Default: false.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | RES_AUTOMATIC_AFTER_DEATH
| style="border-bottom:1px dotted #000000;" | Whether or not your character should attempt resurrecting when he dies. Default: true
|}

===Profile - Friends===
The "Friends" list can be used to mark targets that you do not want to attack. This can be other players that may be marked for PVP, or targets that you want to ignore (ie. "Ystra Ferret"). You may also add players to your friend list to get the bot to assist them when it notices they are fighting something.

Example:
<source lang="xml">
<friends>

<friend name="Jack" /> 
<friend name="Jill" /> 
<friend name="Ambas" /> 
</friends>
</source>

If you want to use umlauts in your friends list, you have to use the escape character with the proper ascii code, since LUA can't handle umlauts (ü=\129, ä=\132, ö=\148, ...). For a mob named 'Kuhkäfer' if would look like
<friend name="Kuhk\132fer" />
For more ASCII character look at the [http://www.cdrummond.qc.ca/cegep/informat/Professeurs/Alain/files/ascii.htm extended ASCII table].

===Profile - Mobs===
The "Mobs" list can be used to limit the mobs we will attack. That can be helpful if you only want to attack one kind of mobs (e.g. for doing a daily). Leave the list empty if you don't want to restrict the bot.

Example:
<source lang="xml">
<mobs>

<mob name="Fungus" />
<mob name="" />
<mob name="" />
</mobs>
</source>

If you want to use umlauts in your list, you have to use the escape character with the proper ascii code, since LUA can't handle umlauts (ü=\129, ä=\132, ö=\148, ...). For a mob named 'Kuhkäfer' if would look like
<mob name="Kuhk\132fer" />
For more ASCII character look at the [http://www.cdrummond.qc.ca/cegep/informat/Professeurs/Alain/files/ascii.htm extended ASCII table].

===Profile - Hotkeys===
<source lang="xml"><hotkeys>

<hotkey name="MACRO" key="VK_0" />
</hotkeys></source>

Although your main hotkeys are configured either through settings.xml or your bindings.txt files, hotkeys for action bars are character or profile specific.

We need only the hotkey to your [http://www.solarstrike.net/wiki/index.php5?title=RoM_Configuration#Settings_up_a_Macro ingame dummy macro].

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | MACRO
| style="border-bottom:1px dotted #000000;" | The hotkey that we use to communicate with the [http://www.solarstrike.net/wiki/index.php5?title=RoM_Configuration#Settings_up_a_Macro ingame dummy macro]. We will call RoM API functions that way
|}

If you used a former bot version before: You now can delete your 'old' hotkeys like RES_MACRO, LOGOUT_MACRO, ...) We don't need them anymore.

===Profile - Skills===
The bot will only attempt to use skills that are noted in your profile. There are two different ways to set skills up: using the 'skills' tag (does not depend on class) or using 'skills_class' (where class is an actual in-game class) tags.

When using the 'skills' tag, it does not mater which main class your character currently is. This works pretty well for non-class specific skills that you wish to use for either class combination. For example, MAGE_FIREBALL is usable as both a mage/priest and priest/mage. Placing MAGE_FIREBALL into this tag will allow it to be used as either mage or priest primary class.

Example:
<source lang="xml">
<skills>
<skill name="MAGE_FIREBALL" hotkey="VK_7" priority="110" hpper="30" inbattle="true" />
</skills>
</source>

You may often use different sets of skills for your two classes. This is when a class-specific skill tag is strongly suggested (that way you don't need to re-confgiure your profile every time you change classes). Skills placed inside this tag will only be used when it matches your primary class. For example, 'skills_mage' skiills will only be used when mage is your primary class.

Example:
<source lang="xml">
<skills_mage>
<skill name="MAGE_FLAME" hotkey="VK_3" priority="80" />
</skills_mage>

<skills_priest>
<skill name="PRIEST_RISING_TIDE" hotkey="VK_3" priority="80" />
</skills_priest>
</source>

'''Skill over-rides:'''
You can over-ride a few options to your skills. Particularly, those skills you want to limit to only use in battle, or set to use at a certain health percent (such as heals).

{|
|- style="padding: 8px;" |
| style="width: 100px; border-bottom:1px dotted #000000;" | priority
| style="border-bottom:1px dotted #000000;" | Higher priority means it will use it before other skills. Use 100+ for your opening attacks.
|-
| style="border-bottom:1px dotted #000000;" | hpper
| style="border-bottom:1px dotted #000000;" | Percentage of HP to use the skill at. Your HP % must be below that level to use the skill. This will over-ride HP_LOW for heals!
|-
| style="border-bottom:1px dotted #000000;" | manaper
| style="border-bottom:1px dotted #000000;" | Percentage of Mana to use the skill at. Your Mana % must be below that level to use the skill.
|-
| style="border-bottom:1px dotted #000000;" | inbattle
| style="border-bottom:1px dotted #000000;" | Either true or false. True means it only can be used in battle; false means if only can be used out of battle.
|-
| style="border-bottom:1px dotted #000000;" | rebuffcut
| style="border-bottom:1px dotted #000000;" | Recast that skill x seconds before the cooldown/duration fades out. Thats usefull for your own buffs.
|-
| style="border-bottom:1px dotted #000000;" | cooldown
| style="border-bottom:1px dotted #000000;" | Cooldown/duration value for that skill. If not set, we use the default value from the skill. You can overwrite that here for special situations.
|-
| style="border-bottom:1px dotted #000000;" | pullonly
| style="border-bottom:1px dotted #000000;" | Can only be used in the pull phase at the begin of a fight. They will not be used during the rest of the fight (only for melee classes if option 'COMBAT_RANGED_PULL' is set to 'true').
|-
| style="border-bottom:1px dotted #000000;" | maxuse
| style="border-bottom:1px dotted #000000;" | Skills with that option will only be used 'maxuse'-times within a fight.
|-
| style="border-bottom:1px dotted #000000;" | autouse
| style="border-bottom:1px dotted #000000;" | Skills with autouse=false will not be automaticly casted from the Bot. Thats usefull if you want to cast a skill only in a event like '<onSkillCast>' .
|}

===Profile - Events===
While botting, several events may be triggered. When these events are triggered, you may have custom Lua code executed. This code is placed directly in the event-specific tags inside your profile.

Events include:
* onLoad : When the profile is loaded
* onDeath: When your character dies
* onLeaveCombat: When leaving combat
* onSkillCast: Triggered after your character uses a skill

onSkillCast will, additionally, receive a Lua table ('arg1') that is a copy of the skill being cast. You can use this to query information about the skill. This can be useful in "skill chaining."

Examples:
<source lang="xml">
<onLoad>
-- Load a waypoint path based on level
if( player.Level > 10 ) then
load_paths("some_path");
else
load_paths("some_other_path");
end
</onLoad>

<onDeath>
printf("\a\a\a"); -- BEEP BEEP BEEP!
pauseOnDeath(); -- Wait for me. Do not continue script execution
</onDeath>

<onLeaveCombat>
if( player.Level > player.free_counter1) then
player.free_counter1 = player.Level;

-- levelup skills
-- 4 = third skill tab, 2 = mage flame
if( player.Level == 2 ) then
send_macro("SetSpellPoint( 4, 2 );");
yrest(1000);
send_macro("SetSpellPoint( 4, 2 );");
else
player.free_counter1 = player.Level;
send_macro("SetSpellPoint( 4, 2 );");
end

-- open giftbag and equipt content
-- updates first 18 bag slots / update all if empty
open_giftbag(player.Level, 18);
end
</onLeaveCombat>

<onSkillCast>
if( arg1.Name == "PRIEST_HOLY_AURA" ) then
yrest(1000);
player:cast("PRIEST_URGENT_HEAL");
end
</onSkillCast>
</source>

== In-Game Settings ==
In order for the bot to fully work, you will need to modify a few in-game settings. You should start with the Interface Settings and then set up your macro hotkey.

===Interface Settings===
Bring up your interface settings under the System menu. Under control, make sure that '''Click-to-move''' and '''Self Cast''' are checked. Under Miscellaneous, also check '''Auto loot'''.

===Settings up a Macro===
This macro is how the bot will interface with RoM's API. You should type ''/macro'' into the game's chat to bring up the macro window. Select the top-left most box and click '''New''', and in the new window that pops open click '''Save'''.

It should now look like this:

[[Image:rom_macro_screen.png]]

Now, all you need to do is click and drag this new icon in your macro window into your hotkey bar and set your MACRO hotkey in [[RoM_Configuration#Profile_-_Hotkeys|profile hotkeys]] to reflect this change.

Note that the macro slot directly to the right of the one you just created will also be used internally. Do not keep macros you intend to use there.

== Expert Settings ==

===Expert Profile - Options===

MAX_TARGET_DIST = 999, -- maximum distance to select a target (helpfull to limit at small places)
AUTO_ELITE_FACTOR = 4, -- mobs with x * your HP value counts as 'Elite' and we will not target it
SKILL_USE_PRIOR = 300, -- cast x ms before cooldown is finished
PK_COUNTS_AS_DEATH = true, -- count playerkill's as death
POTION_COOLDOWN = 15, -- allways 15
POTION_COOLDOWN_HP = 0, -- will only be used if not 0, if 0 POTION_COOLDOWN will be used
POTION_COOLDOWN_MANA = 0, -- will only be used if not 0, if 0 POTION_COOLDOWN will be used
WAYPOINTS_REVERSE = false, -- use the waypoint file in reverse order
MAX_DEATHS = 10, -- maximal death if automatic resurrect befor logout
WAIT_TIME_AFTER_RES = 8000, -- time to wait after resurrection, needs more on slow PCs
RETURNPATH_SUFFIX = "_return", -- suffix for default naming of returnpath
HARVEST_SCAN_WIDTH = 10, -- steps horizontal
HARVEST_SCAN_HEIGHT = 8, -- steps vertical
HARVEST_SCAN_STEPSIZE = 35, -- wide of every step
HARVEST_SCAN_TOPDOWN = false, -- true = top->down false = botton->up
HARVEST_SCAN_XMULTIPLIER = 1.0, -- multiplier for scan width
HARVEST_SCAN_YMULTIPLIER = 1.1, -- multiplier for scan line height
HARVEST_SCAN_YREST = 10, -- scanspeed
HARVEST_SCAN_YMOVE = 1.1, -- move scan area top/down ( 1=middle of screen )
USE_SLEEP_AFTER_RESUME = false, -- enter sleep mode after pressing pause/resume key
IGNORE_MACRO_ERROR = false, -- ignore missing MACRO hotkey error (only temporary option while beta)
DEBUG_INV = false, -- to help to find the item use error (only temporary option while beta)
INV_MAX_SLOTS = 60, -- maximal slots to update in the inventory:update()

RoM Configuration

2009-10-14T23:31:11Z

95.115.30.244: /* Expert Profile - Options */

There are two main settings files for RoM bot: settings.xml and your profile.
Profiles contain character-specific settings, while settings.xml contains hotkey settings and general preferences.

== Settings.xml ==
Here is an example settings file:
<source lang="xml">
<settings>
<hotkeys>

<hotkey description="MOVE_FORWARD" key="VK_W" modifier="" />
<hotkey description="MOVE_BACKWARD" key="VK_S" modifier="" />
<hotkey description="ROTATE_LEFT" key="VK_A" modifier="" />
<hotkey description="ROTATE_RIGHT" key="VK_D" modifier="" />
<hotkey description="STRAFF_LEFT" key="VK_Q" modifier="" />
<hotkey description="STRAFF_RIGHT" key="VK_E" modifier="" />
<hotkey description="JUMP" key="VK_SPACE" modifier="" />

<hotkey description="TARGET" key="VK_TAB" modifier="" />
<hotkey description="TARGET_FRIEND" key="VK_J" modifier="" />
</hotkeys>

<options>
<option name="ENABLE_FIGHT_SLOW_TURN" value="false" />
<option name="MELEE_DISTANCE" value="45" />
<option name="LANGUAGE" value="english" />
<option name="DEBUGGING" value="true" />
</options>
</settings>
</source>

===Settings - Hotkeys===
The hotkey settings are mostly self-explanatory. MOVE_FORWARD, obviously, coresponds to the key that makes your character walk forward. This is "W" by default. Note that '''all''' keys must preceeded by 'VK_'.

You may also notice the 'modifier'. Modifiers are keys such as CONTROL, SHIFT, or ALT. However, be aware that modifiers currently '''do not work'''. You should not set modifiers or you may run into problems. Instead, just leave the modifier set to an empty string("").

If your Runes of Magic bindings file (By default, is located at 'My Documents/Runes of Magic/bindings.txt') can be found and loaded, the RoM bot will instead use these settings so that you will not need to manually change your hotkey settings.

===Settings - Options===
{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | ENABLE_FIGHT_SLOW_TURN
| style="border-bottom:1px dotted #000000;" | Allows you to enable or disable "slow turning" in combat. If you have click-to-move on, you should not need this. It should be set to either "true" or "false". The default is "false".
|-
| style="border-bottom:1px dotted #000000;" | MELEE_DISTANCE
| style="border-bottom:1px dotted #000000;" | The distance at which to conduct melee combat. A value of 45 is good and should not be changed unless you have problems with being either too close or too far away for melee combat. Default: "45".
|-
| style="border-bottom:1px dotted #000000;" | LANGUAGE
| style="border-bottom:1px dotted #000000;" | Allows you to set your prefered language. Acceptable values are "english", "deutsch", , "russian" and "french".
|-
| style="border-bottom:1px dotted #000000;" | USE_CLIENT_LANGUAGE
| style="border-bottom:1px dotted #000000;" | After loading the bot, we will automaticly use the game clients language as bot language.
|-
| style="border-bottom:1px dotted #000000;" | DEBUGGING
| style="border-bottom:1px dotted #000000;" | This is a debugging option. When set to true, it will instantly exit on memory read errors and provide better debugging information. Default: "false".
|}

== Character Profiles ==
There are a few things you should know about character profiles first:
* They typically are named after the character that will use them
* They must be inside the 'rom/profiles' folder
* They must follow proper XML formatting
* They may contain custom Lua code

There are many profile options that can be set so it is highly recommended you make a copy of the default profile (Default.xml) and modify that to your character's needs instead of starting from scratch.

'''If you have extension hiding turned off,''' the .xml extension will not show on any of your files. If this is the case, '''do not''' add the .xml extension or you will end up with a file named something like Default.xml.xml. This may cause the profile to not be found and you may get errors. However, if you are able to see extensions, you should of course include the .xml extension when naming your profile.

===Profile - Options===

<source lang="lua"><options>
<option name="HP_LOW" value="85" />
<option name="MP_LOW_POTION" value="50" />
<option name="HP_LOW_POTION" value="40" />
...
</source>

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Healing and Potions'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HP_LOW
| style="border-bottom:1px dotted #000000;" | The percentage of health to use heal skills at
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HP_LOW_POTION
| style="border-bottom:1px dotted #000000;" | The percentage of health to use potions at
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MP_LOW_POTION
| style="border-bottom:1px dotted #000000;" | The percentage of mana to use mana potions at
|}

{|
| style="background-color: #C0C0FF; text-align: center;" | '''Combat Options'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | COMBAT_TYPE
| style="border-bottom:1px dotted #000000;" | Either "melee" or "ranged". Whichever best fits your character. Default: empty string (""). When unset (default), it will determine this automatically based on your class. There is no need to change this.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | COMBAT_RANGED_PULL
| style="border-bottom:1px dotted #000000;" | Whether or not to attempt to "pull" enemies towards you with ranged skills while you are a melee-based class
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | COMBAT_DISTANCE
| style="border-bottom:1px dotted #000000;" | The distance to remain at when fighting. This only affects your character when COMBAT_TYPE is "ranged" or when you use COMBAT_RANGED_PULL as melee.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MAX_FIGHT_TIME
| style="border-bottom:1px dotted #000000;" | If you stop damaging a target within this amount of time, you will skip this target (prevents getting stuck).
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | DOT_PERCENT
| style="border-bottom:1px dotted #000000;" | Only use DOTs on this target if it has more than this percentage of HP.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | ANTI_KS
| style="border-bottom:1px dotted #000000;" | Whether or not to avoid stealing other players' kills. true or false.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Waypoint and Movement'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | WAYPOINTS
| style="border-bottom:1px dotted #000000;" | The filename (including .xml extension) of the waypoint script to use. Must reside in the 'waypoints' folder!
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | RETURNPATH
| style="border-bottom:1px dotted #000000;" | The filename (including .xml extension) of the waypoint script to use for returning after death. Must reside in the 'waypoints' folder!
|-

| style="width: 200px; border-bottom:1px dotted #000000;" | PATH_TYPE
| style="border-bottom:1px dotted #000000;" | The type of movement to use. Should be either 'waypoints' or 'wander'. See path types for more information.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | WANDER_RADIUS
| style="border-bottom:1px dotted #000000;" | The distance that your character is allowed to "wander" freely when using wander mode.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | WAYPOINT_DEVIATION
| style="border-bottom:1px dotted #000000;" | A 'random' offset applied to each waypoint in your path giving it less of a bot-like appearance; suggested value of 50. Lower value means you stick closer to your normal path; 0 means no deviation.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | QUICK_TURN
| style="border-bottom:1px dotted #000000;" | Whether or not to use quick turn mode. Quick turn mode emulates a click-to-move type movement style. This means your character does not stop to slowly turn around.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Level Difference'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | TARGET_LEVELDIF_ABOVE
| style="border-bottom:1px dotted #000000;" | The maximum level of enemy above your own to engage in combat. i.e. a value of 5 means you will attack monsters up to 5 levels above your own.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | TARGET_LEVELDIF_BELOW
| style="border-bottom:1px dotted #000000;" | The maximum level of enemy below your own to engage in combat. i.e. a value of 5 means you will attack monsters up to 5 levels below your own.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Looting'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT
| style="border-bottom:1px dotted #000000;" | Whether you want to loot enemies or not. True or false.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT_IN_COMBAT
| style="border-bottom:1px dotted #000000;" | Whether or not you want to pick up loot when other enemies are still attacking you.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT_DISTANCE
| style="border-bottom:1px dotted #000000;" | The max distance away a corpse can be that you will attempt to loot.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT_PAUSE_AFTER
| style="border-bottom:1px dotted #000000;" | A percentage probability to attempt a short "rest" (to look more human) after looting an enemy.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Resting'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HP_REST
| style="border-bottom:1px dotted #000000;" | If health falls below this percentage, then rest.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MP_LOW
| style="border-bottom:1px dotted #000000;" | If mana falls below this percentage, then rest.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Log out & Resurrection Settings'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_TIME
| style="border-bottom:1px dotted #000000;" | Log out after this amount of time (in minutes). A value of 0 means you will not use this setting. Default: 0
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_SHUTDOWN
| style="border-bottom:1px dotted #000000;" | If you want to have the computer automatically shutdown after automatically logging out. Default: false
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_WHEN_STUCK
| style="border-bottom:1px dotted #000000;" | If your character gets stuck and cannot unstuck himself, you can use this option to have him log off. Default: true
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_SHUTDOWN
| style="border-bottom:1px dotted #000000;" | If you want to have the computer automatically shutdown after automatically logging out. Default: false.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | RES_AUTOMATIC_AFTER_DEATH
| style="border-bottom:1px dotted #000000;" | Whether or not your character should attempt resurrecting when he dies. Default: true
|}

===Profile - Friends===
The "Friends" list can be used to mark targets that you do not want to attack. This can be other players that may be marked for PVP, or targets that you want to ignore (ie. "Ystra Ferret"). You may also add players to your friend list to get the bot to assist them when it notices they are fighting something.

Example:
<source lang="xml">
<friends>

<friend name="Jack" /> 
<friend name="Jill" /> 
<friend name="Ambas" /> 
</friends>
</source>

If you want to use umlauts in your friends list, you have to use the escape character with the proper ascii code, since LUA can't handle umlauts (ü=\129, ä=\132, ö=\148, ...). For a mob named 'Kuhkäfer' if would look like
<friend name="Kuhk\132fer" />
For more ASCII character look at the [http://www.cdrummond.qc.ca/cegep/informat/Professeurs/Alain/files/ascii.htm extended ASCII table].

===Profile - Mobs===
The "Mobs" list can be used to limit the mobs we will attack. That can be helpful if you only want to attack one kind of mobs (e.g. for doing a daily). Leave the list empty if you don't want to restrict the bot.

Example:
<source lang="xml">
<mobs>

<mob name="Fungus" />
<mob name="" />
<mob name="" />
</mobs>
</source>

If you want to use umlauts in your list, you have to use the escape character with the proper ascii code, since LUA can't handle umlauts (ü=\129, ä=\132, ö=\148, ...). For a mob named 'Kuhkäfer' if would look like
<mob name="Kuhk\132fer" />
For more ASCII character look at the [http://www.cdrummond.qc.ca/cegep/informat/Professeurs/Alain/files/ascii.htm extended ASCII table].

===Profile - Hotkeys===
<source lang="xml"><hotkeys>

<hotkey name="MACRO" key="VK_0" />
</hotkeys></source>

Although your main hotkeys are configured either through settings.xml or your bindings.txt files, hotkeys for action bars are character or profile specific.

We need only the hotkey to your [http://www.solarstrike.net/wiki/index.php5?title=RoM_Configuration#Settings_up_a_Macro ingame dummy macro].

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | MACRO
| style="border-bottom:1px dotted #000000;" | The hotkey that we use to communicate with the [http://www.solarstrike.net/wiki/index.php5?title=RoM_Configuration#Settings_up_a_Macro ingame dummy macro]. We will call RoM API functions that way
|}

If you used a former bot version before: You now can delete your 'old' hotkeys like RES_MACRO, LOGOUT_MACRO, ...) We don't need them anymore.

===Profile - Skills===
The bot will only attempt to use skills that are noted in your profile. There are two different ways to set skills up: using the 'skills' tag (does not depend on class) or using 'skills_class' (where class is an actual in-game class) tags.

When using the 'skills' tag, it does not mater which main class your character currently is. This works pretty well for non-class specific skills that you wish to use for either class combination. For example, MAGE_FIREBALL is usable as both a mage/priest and priest/mage. Placing MAGE_FIREBALL into this tag will allow it to be used as either mage or priest primary class.

Example:
<source lang="xml">
<skills>
<skill name="MAGE_FIREBALL" hotkey="VK_7" priority="110" hpper="30" inbattle="true" />
</skills>
</source>

You may often use different sets of skills for your two classes. This is when a class-specific skill tag is strongly suggested (that way you don't need to re-confgiure your profile every time you change classes). Skills placed inside this tag will only be used when it matches your primary class. For example, 'skills_mage' skiills will only be used when mage is your primary class.

Example:
<source lang="xml">
<skills_mage>
<skill name="MAGE_FLAME" hotkey="VK_3" priority="80" />
</skills_mage>

<skills_priest>
<skill name="PRIEST_RISING_TIDE" hotkey="VK_3" priority="80" />
</skills_priest>
</source>

'''Skill over-rides:'''
You can over-ride a few options to your skills. Particularly, those skills you want to limit to only use in battle, or set to use at a certain health percent (such as heals).

{|
|- style="padding: 8px;" |
| style="width: 100px; border-bottom:1px dotted #000000;" | priority
| style="border-bottom:1px dotted #000000;" | Higher priority means it will use it before other skills. Use 100+ for your opening attacks.
|-
| style="border-bottom:1px dotted #000000;" | hpper
| style="border-bottom:1px dotted #000000;" | Percentage of HP to use the skill at. Your HP % must be below that level to use the skill. This will over-ride HP_LOW for heals!
|-
| style="border-bottom:1px dotted #000000;" | manaper
| style="border-bottom:1px dotted #000000;" | Percentage of Mana to use the skill at. Your Mana % must be below that level to use the skill.
|-
| style="border-bottom:1px dotted #000000;" | inbattle
| style="border-bottom:1px dotted #000000;" | Either true or false. True means it only can be used in battle; false means if only can be used out of battle.
|-
| style="border-bottom:1px dotted #000000;" | rebuffcut
| style="border-bottom:1px dotted #000000;" | Recast that skill x seconds before the cooldown/duration fades out. Thats usefull for your own buffs.
|-
| style="border-bottom:1px dotted #000000;" | cooldown
| style="border-bottom:1px dotted #000000;" | Cooldown/duration value for that skill. If not set, we use the default value from the skill. You can overwrite that here for special situations.
|-
| style="border-bottom:1px dotted #000000;" | pullonly
| style="border-bottom:1px dotted #000000;" | Can only be used in the pull phase at the begin of a fight. They will not be used during the rest of the fight (only for melee classes if option 'COMBAT_RANGED_PULL' is set to 'true').
|-
| style="border-bottom:1px dotted #000000;" | maxuse
| style="border-bottom:1px dotted #000000;" | Skills with that option will only be used 'maxuse'-times within a fight.
|-
| style="border-bottom:1px dotted #000000;" | autouse
| style="border-bottom:1px dotted #000000;" | Skills with autouse=false will not be automaticly casted from the Bot. Thats usefull if you want to cast a skill only in a event like '<onSkillCast>' .
|}

===Profile - Events===
While botting, several events may be triggered. When these events are triggered, you may have custom Lua code executed. This code is placed directly in the event-specific tags inside your profile.

Events include:
* onLoad : When the profile is loaded
* onDeath: When your character dies
* onLeaveCombat: When leaving combat
* onSkillCast: Triggered after your character uses a skill

onSkillCast will, additionally, receive a Lua table ('arg1') that is a copy of the skill being cast. You can use this to query information about the skill. This can be useful in "skill chaining."

Examples:
<source lang="xml">
<onLoad>
-- Load a waypoint path based on level
if( player.Level > 10 ) then
load_paths("some_path");
else
load_paths("some_other_path");
end
</onLoad>

<onDeath>
printf("\a\a\a"); -- BEEP BEEP BEEP!
pauseOnDeath(); -- Wait for me. Do not continue script execution
</onDeath>

<onLeaveCombat>
if( player.Level > player.free_counter1) then
player.free_counter1 = player.Level;

-- levelup skills
-- 4 = third skill tab, 2 = mage flame
if( player.Level == 2 ) then
send_macro("SetSpellPoint( 4, 2 );");
yrest(1000);
send_macro("SetSpellPoint( 4, 2 );");
else
player.free_counter1 = player.Level;
send_macro("SetSpellPoint( 4, 2 );");
end

-- open giftbag and equipt content
-- updates first 18 bag slots / update all if empty
open_giftbag(player.Level, 18);
end
</onLeaveCombat>

<onSkillCast>
if( arg1.Name == "PRIEST_HOLY_AURA" ) then
yrest(1000);
player:cast("PRIEST_URGENT_HEAL");
end
</onSkillCast>
</source>

== In-Game Settings ==
In order for the bot to fully work, you will need to modify a few in-game settings. You should start with the Interface Settings and then set up your macro hotkey.

===Interface Settings===
Bring up your interface settings under the System menu. Under control, make sure that '''Click-to-move''' and '''Self Cast''' are checked. Under Miscellaneous, also check '''Auto loot'''.

===Settings up a Macro===
This macro is how the bot will interface with RoM's API. You should type ''/macro'' into the game's chat to bring up the macro window. Select the top-left most box and click '''New''', and in the new window that pops open click '''Save'''.

It should now look like this:

[[Image:rom_macro_screen.png]]

Now, all you need to do is click and drag this new icon in your macro window into your hotkey bar and set your MACRO hotkey in [[RoM_Configuration#Profile_-_Hotkeys|profile hotkeys]] to reflect this change.

Note that the macro slot directly to the right of the one you just created will also be used internally. Do not keep macros you intend to use there.

== Expert Settings ==

===Expert Profile - Options===

MAX_TARGET_DIST = 999, -- miximum distance to select a target (helpfull to limit at small places)
AUTO_ELITE_FACTOR = 4, -- mobs with x * your HP value counts as 'Elite' and we will not target it
SKILL_USE_PRIOR = 300, -- cast x ms before cooldown is finished
PK_COUNTS_AS_DEATH = true, -- count playerkill's as death
POTION_COOLDOWN = 15, -- allways 15
POTION_COOLDOWN_HP = 0, -- will only be used if not 0, if 0 POTION_COOLDOWN will be used
POTION_COOLDOWN_MANA = 0, -- will only be used if not 0, if 0 POTION_COOLDOWN will be used
WAYPOINTS_REVERSE = false, -- use the waypoint file in reverse order
MAX_DEATHS = 10, -- maximal death if automatic resurrect befor logout
WAIT_TIME_AFTER_RES = 8000, -- time to wait after resurrection, needs more on slow PCs
RETURNPATH_SUFFIX = "_return", -- suffix for default naming of returnpath
HARVEST_SCAN_WIDTH = 10, -- steps horizontal
HARVEST_SCAN_HEIGHT = 8, -- steps vertical
HARVEST_SCAN_STEPSIZE = 35, -- wide of every step
HARVEST_SCAN_TOPDOWN = false, -- true = top->down false = botton->up
HARVEST_SCAN_XMULTIPLIER = 1.0, -- multiplier for scan width
HARVEST_SCAN_YMULTIPLIER = 1.1, -- multiplier for scan line height
HARVEST_SCAN_YREST = 10, -- scanspeed
HARVEST_SCAN_YMOVE = 1.1, -- move scan area top/down ( 1=middle of screen )
USE_SLEEP_AFTER_RESUME = false, -- enter sleep mode after pressing pause/resume key
IGNORE_MACRO_ERROR = false, -- ignore missing MACRO hotkey error (only temporary option while beta)
DEBUG_INV = false, -- to help to find the item use error (only temporary option while beta)
INV_MAX_SLOTS = 60, -- maximal slots to update in the inventory:update()

RoM Auto repair

2009-10-14T23:27:06Z

95.115.30.244:

= Auto Repair at the merchant NPC =

For using the autorepair ingame, you need normaly to press the 'repair' button. You can install the ingame addon [http://rom.curse.com/downloads/rom-addons/details/streamline.aspx Streamline]. Streamline will automaticly repair if you open a dialog window with a merchant and it will automaticly deliver quests, if you open a dialog with a quest NPC.

You can also doing that by using the function

<source lang="lua">player:merchant( npc_name );</source>

It will try to target the nearest NPC's and find the NPC by name. After that, the bot will open the dialog window, autorepair and buy consumables depending from your profile options. It will also work while using multiple bots.

If you only want to target a NPC and do the further stuff by yourself you can use the function:

<source lang="lua">player:target_NPC( npc_name );</source>

Now you have to create a waypoint file, which leads your character to the repair NPC

e.g. '5-7_bugs_repair.xml'
<source lang="xml"><waypoints>

<waypoint x="-12282" z="11183"></waypoint>
<waypoint x="-12391" z="10982"></waypoint>
<waypoint x="-12529" z="10941"></waypoint>
<waypoint x="-808" z="-6067">
player:merchant("Tracy");
load_paths("5-7_bugs_repair_back");
</waypoint>
</waypoints></source>
The bot will use the waypoint file '5-7_bugs_repair_back' to find back the way to the original boting place.

You now have to insert some code into your boting waypoint file (in this example into the file '5-7_bugs.xml'), to give the bot the information when to repair.

== Use a Durability Based AutoRepair ==

It could be based on the duration of your items:<source lang="xml"><waypoint x="13752" z="6726">
if( player.free_flag1 == true ) then
player.free_flag1 = false;
loadPaths("5-7_bugs_repair.xml);
end
</waypoint>
</source>

As you see, we don't check the duration directly in the waypoint file. Simply because the duration is dependent from your armor and by that, dependend from your character. Hence we check the duration in our characters profile and set just a flag, if we should go for repairing.

<source lang="xml"><onLeaveCombat>
local dura = inventory:getMainHandDurability();
printf("Durability:%s\n", dura);
if( dura < 0.9 ) then
player.free_flag1 = true;
end
</onLeaveCombat></source>

== Use a Time Based AutoRepair ==

It could be fight based:<source lang="xml"> <waypoint x="-12364" z="10939">
if( player.Fights-player.free_counter1 > 300 ) then
player.free_counter1 = player.Fights;
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

== Use a Time Based AutoRepair ==

or time based;<source lang="xml"> <waypoint x="-12364" z="10939">
if(player.free_counter1 == 0) then player.free_counter1 = os.time(); end;
if( os.difftime(os.time(), player.free_counter1) > 3600 )
player.free_counter1 = player.BotStartTime_nr;
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

You also could combine some of that methods.

= Auto Sell at the merchant NPC =
There are some expert options for your profile if you want to automaticly sale items to the merchant NPC.

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | INV_AUTOSELL_ENABLE
| style="border-bottom:1px dotted #000000;" | Allows you to enable or disable the Auto Sell function. Valid values are true|false..
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_FROMSLOT
| style="border-bottom:1px dotted #000000;" | Starting bagslot for autosell.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_TOSLOT
| style="border-bottom:1px dotted #000000;" | Ending bagslot for autosell.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_QUALITY
| style="border-bottom:1px dotted #000000;" | Enter the item qualities you want to sell. Recommended value is "white, green".
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_IGNORE
| style="border-bottom:1px dotted #000000;" | Enter items names or part of the names of items, you don't want to sell. You can enter more than one item. Use commata as delimites.
|}

Use the normal 'player:merchant()' function in your waypoint file to autosale your items.

RoM Auto repair

2009-10-14T23:26:30Z

95.115.30.244:

= Auto Repair at the merchant NPC =

For using the autorepair ingame, you need normaly to press the 'repair' button. You can install the ingame addon [http://rom.curse.com/downloads/rom-addons/details/streamline.aspx Streamline]. Streamline will automaticly repair if you open a dialog window with a merchant and it will automaticly deliver quests, if you open a dialog with a quest NPC.

You can also doing that by using the function

<source lang="lua">player:merchant( npc_name );</source>

It will try to target the nearest NPC's and find the NPC by name. After that, the bot will open the dialog window, autorepair and buy consumables depending from your profile options. It will also work while using multiple bots.

If you only want to target a NPC and do the further stuff by yourself you can use the function:

<source lang="lua">player:target_NPC( npc_name );</source>

Now you have to create a waypoint file, which leads your character to the repair NPC

e.g. '5-7_bugs_repair.xml'
<source lang="xml"><waypoints>

<waypoint x="-12282" z="11183"></waypoint>
<waypoint x="-12391" z="10982"></waypoint>
<waypoint x="-12529" z="10941"></waypoint>
<waypoint x="-808" z="-6067">
player:merchant("Tracy");
load_paths("5-7_bugs_repair_back");
</waypoint>
</waypoints></source>
The bot will use the waypoint file '5-7_bugs_repair_back' to find back the way to the original boting place.

You now have to insert some code into your boting waypoint file (in this example into the file '5-7_bugs.xml'), to give the bot the information when to repair.

== Use a Durability Based AutoRepair =

It could be based on the duration of your items:<source lang="xml"><waypoint x="13752" z="6726">
if( player.free_flag1 == true ) then
player.free_flag1 = false;
loadPaths("5-7_bugs_repair.xml);
end
</waypoint>
</source>

As you see, we don't check the duration directly in the waypoint file. Simply because the duration is dependent from your armor and by that, dependend from your character. Hence we check the duration in our characters profile and set just a flag, if we should go for repairing.

<source lang="xml"><onLeaveCombat>
local dura = inventory:getMainHandDurability();
printf("Durability:%s\n", dura);
if( dura < 0.9 ) then
player.free_flag1 = true;
end
</onLeaveCombat></source>

== Use a Time Based AutoRepair =

It could be fight based:<source lang="xml"> <waypoint x="-12364" z="10939">
if( player.Fights-player.free_counter1 > 300 ) then
player.free_counter1 = player.Fights;
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

== Use a Time Based AutoRepair =

or time based;<source lang="xml"> <waypoint x="-12364" z="10939">
if(player.free_counter1 == 0) then player.free_counter1 = os.time(); end;
if( os.difftime(os.time(), player.free_counter1) > 3600 )
player.free_counter1 = player.BotStartTime_nr;
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

You also could combine some of that methods.

= Auto Sell at the merchant NPC =
There are some expert options for your profile if you want to automaticly sale items to the merchant NPC.

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | INV_AUTOSELL_ENABLE
| style="border-bottom:1px dotted #000000;" | Allows you to enable or disable the Auto Sell function. Valid values are true|false..
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_FROMSLOT
| style="border-bottom:1px dotted #000000;" | Starting bagslot for autosell.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_TOSLOT
| style="border-bottom:1px dotted #000000;" | Ending bagslot for autosell.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_QUALITY
| style="border-bottom:1px dotted #000000;" | Enter the item qualities you want to sell. Recommended value is "white, green".
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_IGNORE
| style="border-bottom:1px dotted #000000;" | Enter items names or part of the names of items, you don't want to sell. You can enter more than one item. Use commata as delimites.
|}

Use the normal 'player:merchant()' function in your waypoint file to autosale your items.

RoM Auto repair

2009-10-14T23:24:42Z

95.115.30.244:

= Auto Repair at the merchant NPC =

For using the autorepair ingame, you need normaly to press the 'repair' button. You can install the ingame addon [http://rom.curse.com/downloads/rom-addons/details/streamline.aspx Streamline]. Streamline will automaticly repair if you open a dialog window with a merchant and it will automaticly deliver quests, if you open a dialog with a quest NPC.

You can also doing that by using the function

<source lang="lua">player:merchant( npc_name );</source>

It will try to target the nearest NPC's and find the NPC by name. After that, the bot will open the dialog window, autorepair and buy consumables depending from your profile options. It will also work while using multiple bots.

If you only want to target a NPC and do the further stuff by yourself you can use the function:

<source lang="lua">player:target_NPC( npc_name );</source>

Now you have to create a waypoint file, which leads your character to the repair NPC

e.g. '5-7_bugs_repair.xml'
<source lang="xml"><waypoints>

<waypoint x="-12282" z="11183"></waypoint>
<waypoint x="-12391" z="10982"></waypoint>
<waypoint x="-12529" z="10941"></waypoint>
<waypoint x="-808" z="-6067">
player:merchant("Tracy");
load_paths("5-7_bugs_repair_back");
</waypoint>
</waypoints></source>
The bot will use the waypoint file '5-7_bugs_repair_back' to find back the way to the original boting place.

You now have to insert some code into your boting waypoint file (in this example into the file '5-7_bugs.xml'), to give the bot the information when to repair.

It could be based on the duration of your items:<source lang="xml"><waypoint x="13752" z="6726">
if( player.free_flag1 == true ) then
player.free_flag1 = false;
loadPaths("5-7_bugs_repair.xml);
end
</waypoint>
</source>

As you see, we don't check the duration directly in the waypoint file. Simply because the duration is dependent from your armor and by that, dependend from your character. Hence we check the duration in our characters profile and set just a flag, if we should go for repairing.

<source lang="xml"><onLeaveCombat>
local dura = inventory:getMainHandDurability();
printf("Durability:%s\n", dura);
if( dura < 0.9 ) then
player.free_flag1 = true;
end
</onLeaveCombat></source>

It could be fight based:<source lang="xml"> <waypoint x="-12364" z="10939">
if( player.Fights-player.free_counter1 > 300 ) then
player.free_counter1 = player.Fights;
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

or time based;<source lang="xml"> <waypoint x="-12364" z="10939">
if(player.free_counter1 == 0) then player.free_counter1 = os.time(); end;
if( os.difftime(os.time(), player.free_counter1) > 3600 )
player.free_counter1 = player.BotStartTime_nr;
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

You also could combine some of that methods.

= Auto Sell at the merchant NPC =
There are some expert options for your profile if you want to automaticly sale items to the merchant NPC.

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | INV_AUTOSELL_ENABLE
| style="border-bottom:1px dotted #000000;" | Allows you to enable or disable the Auto Sell function. Valid values are true|false..
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_FROMSLOT
| style="border-bottom:1px dotted #000000;" | Starting bagslot for autosell.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_TOSLOT
| style="border-bottom:1px dotted #000000;" | Ending bagslot for autosell.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_QUALITY
| style="border-bottom:1px dotted #000000;" | Enter the item qualities you want to sell. Recommended value is "white, green".
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_IGNORE
| style="border-bottom:1px dotted #000000;" | Enter items names or part of the names of items, you don't want to sell. You can enter more than one item. Use commata as delimites.
|}

Use the normal 'player:merchant()' function in your waypoint file to autosale your items.

RoM Custom Scripting

2009-10-14T23:18:25Z

95.115.30.244:

* [[RoM Heal Yourself|How To: Heal yourself with the Bot]]
* [[RoM Harvest|How To: Harvest]]
* [[RoM Leveling|How To: Automatic Leveling e.g. Level 1-10]] - Connect waypoint files, level up skills, open bags and equipt items
* [[RoM Working with waypoint files|How to work with waypoint files]]
* [[RoM Auto repair|How To: Auto Repair and Auto Sell]]
* [[RoM Click in foreground|How to use mouseclick on foreground window]]

RoM Custom Scripting

2009-10-14T23:17:56Z

95.115.30.244:

* [[RoM Heal Yourself|How To: Heal yourself with the Bot]]
* [[RoM Harvest|How To: Harvest]]
* [[RoM Leveling|How To: Automatic Leveling e.g. Level 1-10]] - Connect waypoint files, level up skills, open bags and equipt items
* [[RoM Working with waypoint files|How to work with waypoint files]]
* [[RoM Auto repair|How To: Auto repair]]
* [[RoM Click in foreground|How to use mouseclick on foreground window]]

RoM Bot

2009-10-14T23:17:30Z

95.115.30.244:

* [[RoM Getting started|Getting started]] - Download the installation files and run the demo
* [[RoM Configuration|Configuration]] - Configure the RoM bot to your needs
* [[RoM Waypoinf files|Waypoint files]] - Working with waypoint files
* [[RoM Functions|Functions]] - List of functions you can use in your own profile events and waypoint files.
* [[RoM Variables|Variables]] - List of important variables you can use in your own profile events and waypoint files.
* [[RoM Custom Scripting|Examples & Tutorials]] - Learn how to do various tasks with the RoM Bot.
* [[RoM Troubleshooting|Troubleshooting]] - How you can help yourself if you get problems.

RoM Troubleshooting

2009-10-14T23:17:01Z

95.115.30.244: New page: = Debugging options = There are some special profile options to print out some debugging messages. Please enter that options in your profile e.g.: <option name="DEBUG_TARGET" value="tru...

= Debugging options =
There are some special profile options to print out some debugging messages. Please enter that options in your profile e.g.:

<option name="DEBUG_TARGET" value="true" />
...

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | DEBUG_TARGET
| style="border-bottom:1px dotted #000000;" | Print out some targeting informations.
|-
| style="border-bottom:1px dotted #000000;" | DEBUG_LOOT
| style="border-bottom:1px dotted #000000;" | Print out messages why we don't loot.
|-
| style="border-bottom:1px dotted #000000;" | DEBUG_INV
| style="border-bottom:1px dotted #000000;" | Printout messages about the inventory update process.
|-
| style="border-bottom:1px dotted #000000;" | DEBUG_HARVEST
| style="border-bottom:1px dotted #000000;" | Print out some messages about the harvesting process.
|}

RoM Bot

2009-10-14T23:12:13Z

95.115.30.244: