SolarStrike wiki - User contributions [en]

RoM Auto repair

2009-11-19T00:44:02Z

D003232: /* Use a Items Based AutoRepair */

= 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 Fight 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 ) then
player.free_counter1 = os.time();
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

== Use a Items Based AutoRepair ==

You also can check for an item amount like healing or mana potions. But I would recommend more to use a durability check and by that fill up enough of your potions <source lang="xml"> <waypoint x="-12364" z="10939">
if( 20 > inventory:itemTotalCount(<itemNameOrId>) ) then
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>
Replace <itemNameOrId> with the itemname or item-id of the potions you want to check. Be sure your cached inventory is up to date. See the [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions#Inventory_and_Item_Functions inventory functions section] for more informatione about that.

== Switch an item ==

Instead of repairing your items, you could also switch a item based on the durabilty:

<source lang="xml"><onLeaveCombat>
local dura = inventory:getMainHandDurability();
printf("Durability:%s\n", dura);
if( dura < 0.9 ) then
inventory:useItem(<itemNameOrId>);
end
</onLeaveCombat></source>
Replace '<itemNameOrId>' with the itemname or itemid of the item you want to equipt. You have to be sure that your [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions#Inventory_and_Item_Functions inventory is up to date], because the funtion 'inventory:useItem(itemNameOrId);' uses the cached inventory.

You also could combine some of that methods.

= Auto Sell at the merchant NPC =

==General Autosell Options==

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

<source lang="xml"><option name="INV_AUTOSELL_ENABLE" value="true" />
<option name="INV_AUTOSELL_FROMSLOT" value="61" />
<option name="INV_AUTOSELL_TOSLOT" value="120" />
<option name="INV_AUTOSELL_QUALITY" value="white, green" />
<option name="INV_AUTOSELL_IGNORE" value="Pfeil, Elementar, III" /></source>

{|
|- 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. Bag 1 has slots 1-30, bag 2 has slots 31-60, ...
|-
| 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" ( white | green | blue | purple | orange | gold).
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_IGNORE
| style="border-bottom:1px dotted #000000;" | Enter items names (or parts of the names) or item-Ids, 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. The bagslot are starting from the top left with 1, 2, 3, ... in the first row, 6, 7, 8, ... in the second row, ...

==Check Durability and Stats while using Autosell==

You can also check the durability and/or stats of an item while selling it. We need to read the ingame tooltip to check the durability and the stats. That's at the moment not possible by only using the RoMScript() MACRO function. So we need a little ingame addon. That addon is named 'igf' (ingamefunctions). You found that addon in the bot folder 'rom/devtools/'.

'''Please copy the folder 'ingamefunctions' into your RoM installation into the folder '\Runes of Magic\Interface\AddOns' to install that addon. And restart the RoM games client.
'''

<source lang="xml"><option name="INV_AUTOSELL_NOSELL_DURA" value="110" />
<option name="INV_AUTOSELL_STATS_NOSELL" value=" X,XI" />
<option name="INV_AUTOSELL_STATS_SELL" value="IX" /></source>

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | INV_AUTOSELL_NOSELL_DURA
| style="border-bottom:1px dotted #000000;" | Items with a durability eq or greater that value will not be sold.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_STATS_NOSELL
| style="border-bottom:1px dotted #000000;" | Items with that text strings in the right tooltip side will not be sold. Caution: It's only a very easy check. So that text strings are checked against the whole right side tooltip text. E.g. if you want to save the stat 'defense', also items with 'magical defense' will not be sold. Not only items with the stat 'defense'. Sry for that. If you set the value 'X', all stats with 'X' wouldn't be sold: 'X', 'IX', 'XI'.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_STATS_SELL
| style="border-bottom:1px dotted #000000;" | By using that items, you could overwrite the 'INV_AUTOSELL_STATS_NOSELL' value. e.g. if you set 'INV_AUTOSELL_STATS_NOSELL'="X" you would not sell 'IX' stats. But if you know set 'INV_AUTOSELL_STATS_SELL="IX" you would sell 'IX' stats and save all other stats with 'X'.
|}

==Debuging Option for Autosell==

You can use the option:
<option name="DEBUG_AUTOSELL" value="true" />
to get some debuging options while using autosell.

RoM Auto repair

2009-11-09T09:30:19Z

D003232:

= 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 Fight 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 ) then
player.free_counter1 = os.time();
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

== Use a Items Based AutoRepair ==

You also can check for an item amount like healing or mana potions. But I would recommend more to use a durability check and by that fill up enough of your potions <source lang="xml"> <waypoint x="-12364" z="10939">
if( inventory:itemTotalCount(<itemNameOrId>) < 20 ) then
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>
Replace <itemNameOrId> with the itemname or item-id of the potions you want to check. Be sure your cached inventory is up to date. See the [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions#Inventory_and_Item_Functions inventory functions section] for more informatione about that.

== Switch an item ==

Instead of repairing your items, you could also switch a item based on the durabilty:

<source lang="xml"><onLeaveCombat>
local dura = inventory:getMainHandDurability();
printf("Durability:%s\n", dura);
if( dura < 0.9 ) then
inventory:useItem(<itemNameOrId>);
end
</onLeaveCombat></source>
Replace '<itemNameOrId>' with the itemname or itemid of the item you want to equipt. You have to be sure that your [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions#Inventory_and_Item_Functions inventory is up to date], because the funtion 'inventory:useItem(itemNameOrId);' uses the cached inventory.

You also could combine some of that methods.

= Auto Sell at the merchant NPC =

==General Autosell Options==

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

<source lang="xml"><option name="INV_AUTOSELL_ENABLE" value="true" />
<option name="INV_AUTOSELL_FROMSLOT" value="61" />
<option name="INV_AUTOSELL_TOSLOT" value="120" />
<option name="INV_AUTOSELL_QUALITY" value="white, green" />
<option name="INV_AUTOSELL_IGNORE" value="Pfeil, Elementar, III" /></source>

{|
|- 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. Bag 1 has slots 1-30, bag 2 has slots 31-60, ...
|-
| 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" ( white | green | blue | purple | orange | gold).
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_IGNORE
| style="border-bottom:1px dotted #000000;" | Enter items names (or parts of the names) or item-Ids, 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. The bagslot are starting from the top left with 1, 2, 3, ... in the first row, 6, 7, 8, ... in the second row, ...

==Check Durability and Stats while using Autosell==

You can also check the durability and/or stats of an item while selling it. We need to read the ingame tooltip to check the durability and the stats. That's at the moment not possible by only using the RoMScript() MACRO function. So we need a little ingame addon. That addon is named 'igf' (ingamefunctions). You found that addon in the bot folder 'rom/devtools/'.

'''Please copy the folder 'ingamefunctions' into your RoM installation into the folder '\Runes of Magic\Interface\AddOns' to install that addon. And restart the RoM games client.
'''

<source lang="xml"><option name="INV_AUTOSELL_NOSELL_DURA" value="110" />
<option name="INV_AUTOSELL_STATS_NOSELL" value=" X,XI" />
<option name="INV_AUTOSELL_STATS_SELL" value="IX" /></source>

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | INV_AUTOSELL_NOSELL_DURA
| style="border-bottom:1px dotted #000000;" | Items with a durability eq or greater that value will not be selled.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_STATS_NOSELL
| style="border-bottom:1px dotted #000000;" | Items with that text strings in the right tooltip side will not be selled. Caution: It's only a very easy check. So that text strings are checked against the whole right side tooltip text. E.g. if you want to save the stat 'defense', also items with 'magical defense' will not be selled. Not only items with the stat 'defense'. Sry for that. If you set the value 'X', all stats with 'X' wouldn't be selled: 'X', 'IX', 'XI'.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_STATS_SELL
| style="border-bottom:1px dotted #000000;" | By using that items, you could overwrite the 'INV_AUTOSELL_STATS_NOSELL' value. e.g. if you set 'INV_AUTOSELL_STATS_NOSELL'="X" you would not sell 'IX' stats. But if you know set 'INV_AUTOSELL_STATS_SELL="IX" you would sell 'IX' stats and save all other stats with 'X'.
|}

==Debuging Option for Autosell==

You can use the option:
<option name="DEBUG_AUTOSELL" value="true" />
to get some debuging options while using autosell.

RoM Auto repair

2009-11-08T23:41:35Z

D003232: /* Auto Sell at the merchant NPC */

= 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 Fight 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 ) then
player.free_counter1 = os.time();
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

== Switch an item ==

Instead of repairing your items, you could also switch a item based on the durabilty:

<source lang="xml"><onLeaveCombat>
local dura = inventory:getMainHandDurability();
printf("Durability:%s\n", dura);
if( dura < 0.9 ) then
inventory:useItem(<itemNameOrId>);
end
</onLeaveCombat></source>
Replace '<itemNameOrId>' with the itemname or itemid of the item you want to equipt. You have to be sure that your [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions#Inventory_and_Item_Functions inventory is up to date], because the funtion 'inventory:useItem(itemNameOrId);' uses the cached inventory.

You also could combine some of that methods.

= Auto Sell at the merchant NPC =

==General Autosell Options==

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

<source lang="xml"><option name="INV_AUTOSELL_ENABLE" value="true" />
<option name="INV_AUTOSELL_FROMSLOT" value="61" />
<option name="INV_AUTOSELL_TOSLOT" value="120" />
<option name="INV_AUTOSELL_QUALITY" value="white, green" />
<option name="INV_AUTOSELL_IGNORE" value="Pfeil, Elementar, III" /></source>

{|
|- 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. Bag 1 has slots 1-30, bag 2 has slots 31-60, ...
|-
| 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" ( white | green | blue | purple | orange | gold).
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_IGNORE
| style="border-bottom:1px dotted #000000;" | Enter items names (or parts of the names) or item-Ids, 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. The bagslot are starting from the top left with 1, 2, 3, ... in the first row, 6, 7, 8, ... in the second row, ...

==Check Durability and Stats while using Autosell==

You can also check the durability and/or stats of an item while selling it. We need to read the ingame tooltip to check the durability and the stats. That's at the moment not possible by only using the RoMScript() MACRO function. So we need a little ingame addon. That addon is named 'igf' (ingamefunctions). You found that addon in the bot folder 'rom/devtools/'.

'''Please copy the folder 'ingamefunctions' into your RoM installation into the folder '\Runes of Magic\Interface\AddOns' to install that addon. And restart the RoM games client.
'''

<source lang="xml"><option name="INV_AUTOSELL_NOSELL_DURA" value="110" />
<option name="INV_AUTOSELL_STATS_NOSELL" value=" X,XI" />
<option name="INV_AUTOSELL_STATS_SELL" value="IX" /></source>

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | INV_AUTOSELL_NOSELL_DURA
| style="border-bottom:1px dotted #000000;" | Items with a durability eq or greater that value will not be selled.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_STATS_NOSELL
| style="border-bottom:1px dotted #000000;" | Items with that text strings in the right tooltip side will not be selled. Caution: It's only a very easy check. So that text strings are checked against the whole right side tooltip text. E.g. if you want to save the stat 'defense', also items with 'magical defense' will not be selled. Not only items with the stat 'defense'. Sry for that. If you set the value 'X', all stats with 'X' wouldn't be selled: 'X', 'IX', 'XI'.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_STATS_SELL
| style="border-bottom:1px dotted #000000;" | By using that items, you could overwrite the 'INV_AUTOSELL_STATS_NOSELL' value. e.g. if you set 'INV_AUTOSELL_STATS_NOSELL'="X" you would not sell 'IX' stats. But if you know set 'INV_AUTOSELL_STATS_SELL="IX" you would sell 'IX' stats and save all other stats with 'X'.
|}

==Debuging Option for Autosell==

You can use the option:
<option name="DEBUG_AUTOSELL" value="true" />
to get some debuging options while using autosell.

RoM Auto repair

2009-11-08T23:37:50Z

D003232: /* Auto Sell at the merchant NPC */

= 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 Fight 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 ) then
player.free_counter1 = os.time();
load_paths("5-7_bugs_repair.xml");
end
</waypoint>
</source>

== Switch an item ==

Instead of repairing your items, you could also switch a item based on the durabilty:

<source lang="xml"><onLeaveCombat>
local dura = inventory:getMainHandDurability();
printf("Durability:%s\n", dura);
if( dura < 0.9 ) then
inventory:useItem(<itemNameOrId>);
end
</onLeaveCombat></source>
Replace '<itemNameOrId>' with the itemname or itemid of the item you want to equipt. You have to be sure that your [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions#Inventory_and_Item_Functions inventory is up to date], because the funtion 'inventory:useItem(itemNameOrId);' uses the cached inventory.

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.

<source lang="xml"><option name="INV_AUTOSELL_ENABLE" value="true" />
<option name="INV_AUTOSELL_FROMSLOT" value="61" />
<option name="INV_AUTOSELL_TOSLOT" value="120" />
<option name="INV_AUTOSELL_QUALITY" value="white, green" />
<option name="INV_AUTOSELL_IGNORE" value="Pfeil, Elementar, III" /></source>

{|
|- 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. Bag 1 has slots 1-30, bag 2 has slots 31-60, ...
|-
| 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" ( white | green | blue | purple | orange | gold).
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_IGNORE
| style="border-bottom:1px dotted #000000;" | Enter items names (or parts of the names) or item-Ids, 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. The bagslot are starting from the top left with 1, 2, 3, ... in the first row, 6, 7, 8, ... in the second row, ...

You can also check the durability and/or stats of an item while selling it. We need to read the ingame tooltip to check the durability and the stats. That's at the moment not possible by only using the RoMScript() MACRO function. So we need a little ingame addon. That addon is named 'igf' (ingamefunctions). You found that addon in the bot folder 'rom/devtools/'.

'''Please copy the folder 'ingamefunctions' into your RoM installation into the folder '\Runes of Magic\Interface\AddOns' to install that addon. And restart the RoM games client.
'''

<source lang="xml"><option name="INV_AUTOSELL_NOSELL_DURA" value="110" />
<option name="INV_AUTOSELL_STATS_NOSELL" value=" X,XI" />
<option name="INV_AUTOSELL_STATS_SELL" value="IX" /></source>

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | INV_AUTOSELL_NOSELL_DURA
| style="border-bottom:1px dotted #000000;" | Items with a durability eq or greater that value will not be selled.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_STATS_NOSELL
| style="border-bottom:1px dotted #000000;" | Items with that text strings in the right tooltip side will not be selled. Caution: It's only a very easy check. So that text strings are checked against the whole right side tooltip text. E.g. if you want to save the stat 'defense', also items with 'magical defense' will not be selled. Not only items with the stat 'defense'. Sry for that. If you set the value 'X', all stats with 'X' wouldn't be selled: 'X', 'IX', 'XI'.
|-
| style="border-bottom:1px dotted #000000;" | INV_AUTOSELL_STATS_SELL
| style="border-bottom:1px dotted #000000;" | By using that items, you could overwrite the 'INV_AUTOSELL_STATS_NOSELL' value. e.g. if you set 'INV_AUTOSELL_STATS_NOSELL'="X" you would not sell 'IX' stats. But if you know set 'INV_AUTOSELL_STATS_SELL="IX" you would sell 'IX' stats and save all other stats with 'X'.
|}

RoM Functions

2009-11-04T08:47:13Z

D003232: /* Waypoint File Functions */

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbags1To10( [[_player_level] , _maxslot] );
open the level 1-10 giftbags and equipt the items.

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

== Player Functions ==
player:harvest(["test"|id]);
Use 'player:harvest()' to scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground). Use 'player:harvest("test")' to list id's of objects in front of you (e.g. quest objects), use 'player:harvest(id-nr)' to scan and use/open a object with that given object-id.

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

== Inventory and Item Functions ==

inventory:getItemCount(itemId)

examples:
if( inventory:getItemCount(214536) > 25 ) then
loadPaths("deliver_quest");
end
Get the quantity for a item directly from the games client.

inventory:itemTotalCount(itemNameOrId)
Get the quantity for a item from the cached inventory. You have to be sure, that your inventory is up to date to get the right values. You can use the item-id or the name of the item

inventory:useItem(itemNameOrId)
Use a item from the cached inventory.

inventory:update()
Update the whole inventory from the games client. Depending from you slots, that takes about 10-15 seconds. Nevertheless from using that function, the bot updates the whole inventory at the bot starting time and about 3-4 slots after every fight and about 10-15 slots while the bot is looting.

By default the bot updates slot 1-60. If you want to use more slots please use the profile option
<option name="INV_MAX_SLOTS" value="120" /> 
Use the option
<option name="INV_MAX_SLOTS" value="0" /> 
if you want to deactivate the inventory update.

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is usefull to put that at the first and at the last waypoint if you want to run between two places.

__WPL:setWaypointIndex( number);
Set the waypoint # 'number' as next waypoint to reach

__WPL:getNearestWaypoint(player.X, player.Z);
Get back the number of the closest waypoint.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

== Using of RoM API Functions ==
With the function sendMacro() or RoMScript() we can submit macros to the RoM API. Here some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

/script SendSystemChat(tonumber(string.sub(GetBagItemLink(GetBagItemInfo(1)), 8, 12), 16));
Print the itemid of slot-nr 1 into the system chat. Change the slot number to the item you want to get informations about or move that item to slot #1.

sendMacro("GetBagItemCount("..itemid..")")
Get back the quantity of an givem item ID in your bags.

occupiedSlots, totalSlots = sendMacro("GetBagCount();");
Get back the number of total slots in your bag and the number of the occupied slot in your bag.

RoM Functions

2009-11-04T08:46:22Z

D003232: /* Waypoint File Functions */

RoM Functions

2009-11-02T08:45:12Z

D003232: /* Inventory and Item Functions */

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbags1To10( [[_player_level] , _maxslot] );
open the level 1-10 giftbags and equipt the items.

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

== Player Functions ==
player:harvest(["test"|id]);
Use 'player:harvest()' to scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground). Use 'player:harvest("test")' to list id's of objects in front of you (e.g. quest objects), use 'player:harvest(id-nr)' to scan and use/open a object with that given object-id.

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

== Inventory and Item Functions ==

inventory:getItemCount(itemId)

examples:
if( inventory:getItemCount(214536) > 25 ) then
loadPaths("deliver_quest");
end
Get the quantity for a item directly from the games client.

inventory:itemTotalCount(itemNameOrId)
Get the quantity for a item from the cached inventory. You have to be sure, that your inventory is up to date to get the right values. You can use the item-id or the name of the item

inventory:useItem(itemNameOrId)
Use a item from the cached inventory.

inventory:update()
Update the whole inventory from the games client. Depending from you slots, that takes about 10-15 seconds. Nevertheless from using that function, the bot updates the whole inventory at the bot starting time and about 3-4 slots after every fight and about 10-15 slots while the bot is looting.

By default the bot updates slot 1-60. If you want to use more slots please use the profile option
<option name="INV_MAX_SLOTS" value="120" /> 
Use the option
<option name="INV_MAX_SLOTS" value="0" /> 
if you want to deactivate the inventory update.

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is usefull to put that at the first and at the last waypoint if you want to run between two places.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

== Using of RoM API Functions ==
With the function sendMacro() or RoMScript() we can submit macros to the RoM API. Here some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

/script SendSystemChat(tonumber(string.sub(GetBagItemLink(GetBagItemInfo(1)), 8, 12), 16));
Print the itemid of slot-nr 1 into the system chat. Change the slot number to the item you want to get informations about or move that item to slot #1.

sendMacro("GetBagItemCount("..itemid..")")
Get back the quantity of an givem item ID in your bags.

occupiedSlots, totalSlots = sendMacro("GetBagCount();");
Get back the number of total slots in your bag and the number of the occupied slot in your bag.

RoM Auto repair

2009-11-02T08:44:39Z

D003232:

RoM Auto repair

2009-11-01T20:58:00Z

D003232: /* Use a Time Based AutoRepair */

RoM Auto repair

2009-11-01T06:39:17Z

D003232: /* Use a Time Based AutoRepair */

RoM Troubleshooting

2009-10-31T11:19:00Z

D003232:

= 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.
|}

= Debugging Inentory Issues =

You can set the option
<option name="DEBUG_INV" value="true" />
to get debuging informations about the inventory update process. Main reason for update errors is a not proper working MACRO hotekey. That could be caused by a corruped macro file.

'''Solution for a corrupt macro file:'''
Close the games client. Delete the macro file 'Macro.bsd' at 'My Documents\Runes of Magic\<charname>'. Restart the game and the bot again and [http://www.solarstrike.net/wiki/index.php5?title=RoM_Getting_started#Configure_the_macro configure a new empty macro as described here].

= Debugging Skill Use Issues =

There are a lot of possible reasons if a skill will not used as you estimate. Mostly it's the misuse of options in the skills section within the profile. You can activate debugging messages to see the skill use checks. You have to set that option in the <onLoad> event.

<source lang="xml"><onLoad>

settings.profile.options.DEBUG_SKILLUSE.ENABLE = true;

</onLoad></source>If you enable that option, you will be spammed with a lot of messages. You can deactivate every type of message by using the following options (one 'false' setting for every type of message).

settings.profile.options.DEBUG_SKILLUSE.TIMEGAP = true;
settings.profile.options.DEBUG_SKILLUSE.ONCOOLDOWN = false;
settings.profile.options.DEBUG_SKILLUSE.HPLOW = false;
settings.profile.options.DEBUG_SKILLUSE.MAXHPPER = false;
settings.profile.options.DEBUG_SKILLUSE.ONLYFRIENDLY = false;
settings.profile.options.DEBUG_SKILLUSE.ONLYINBATTLE = false;
settings.profile.options.DEBUG_SKILLUSE.NOTINBATTLE = false;
settings.profile.options.DEBUG_SKILLUSE.TARGETNOENEMY = false;
...

RoM Configuration

2009-10-29T20:58:40Z

D003232: /* Profile - Skills */

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;" | '''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;" | '''Shopping options'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HEALING_POTION
| style="border-bottom:1px dotted #000000;" | How many healing potions should we have in the inventory after visiting a merchant.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MANA_POTION
| style="border-bottom:1px dotted #000000;" | How many mana potions should we have in the inventory after visiting a merchant.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | ARROW_QUIVER
| style="border-bottom:1px dotted #000000;" | How many arrow quivers should we have in the inventory after visiting a merchant.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | THROWN_BAG
| style="border-bottom:1px dotted #000000;" | How many thrown bags should we have in the inventory after visiting a merchant.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | POISON
| style="border-bottom:1px dotted #000000;" | How many poison should we have in the inventory after visiting a merchant.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Ammunition reload'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | RELOAD_AMMUNITION
| style="border-bottom:1px dotted #000000;" | Which kind of ammunition should we reload ( arrow | thrown | false) .
|}

{|
| 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;" | '''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' skills 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>

'''Hotkeys:'''
You can only use hotkeys without modifiers. Normaly that are the keys 'a-z' and '0-9'. If you want to use special keys like MINUS, PLUS, ... take a look into the file '\micromacro\lib\mods\keyboard\en_uk.lua' to find the right virtual keyname. Alternately you can assign the hotkey "MACRO". In that case the skill will be cast by using the RoM API function 'CastSpellByName()' via the MACRO hotkey (it is not garanted, that all needed skill names are within the database file 'skills_local.xml').

'''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;" | targethp
| style="border-bottom:1px dotted #000000;" | Targets HP in healthpoints has to be below this level to use the skill.
|-
| style="border-bottom:1px dotted #000000;" | targethpper
| style="border-bottom:1px dotted #000000;" | Targets HP in percentage has to be below this level to use the skill.
|-
| 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 Fight Support Only

2009-10-29T15:32:28Z

D003232: New page: =How To use the Bot as Fight Support only System= ==Deactivating of the Targeting Function== Set the option <option name="AUTO_TARGET" value="false" /> if you want to deactivate the tar...

=How To use the Bot as Fight Support only System=

==Deactivating of the Targeting Function==
Set the option
<option name="AUTO_TARGET" value="false" />
if you want to deactivate the targeting function. If you do so, you can target you mobs by yourselfe. The bot will start fighting a mob if you select a target.
==Deactivating of the Movement Function==
If you only want to use the bot as fight support system without moving along a waypoint file, you can set the profile option:
<option name="PATH_TYPE" value="wander"/>
<option name="WANDER_RADIUS" value="0" />
Or just set the WANDER_RADIUS to '0' and select point '0: wander' within your pathlist. After doing that you can move your character manual to every position in the game. Depending from your setting for the targeting function, you can select your own targets or let the bot select the targets.
==Using the Sleep Mode==
You can optional to the options above also use the Sleep mode to set the bot to sleeping after ever fight is finished. Use the profile option:
<option name="USE_SLEEP_AFTER_RESUME" value="true" />
to go to sleep after a fight. You have to press the 'END' key for pause the bot and directly after that press the 'DEL' key to resume. After that the bot will go to sleep as soon as possible. If you get aggro or pull a mob, the bot will awake and fight and after the fight go to sleep again.

That's also a good solution if you want to go AFK and want to be able to fight back respawns or PK players.

RoM Custom Scripting

2009-10-29T15:21:25Z

D003232:

* [[RoM Heal Yourself|How To: Heal yourself with the Bot]]
* [[RoM Working with profile events|How To: Working with profile events]]
* [[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 Fight Support Only|How To: Use the Bot as Fight Support Only]]
* [[RoM Looting Issues|How To: Looting Issues, Lootfilter, Problems ...]]
* [[RoM Click in foreground|How to use mouseclick on foreground window]]

RoM Functions

2009-10-29T13:37:52Z

D003232: /* Inventory and Item Functions */

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbags1To10( [[_player_level] , _maxslot] );
open the level 1-10 giftbags and equipt the items.

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

== Player Functions ==
player:harvest(["test"|id]);
Use 'player:harvest()' to scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground). Use 'player:harvest("test")' to list id's of objects in front of you (e.g. quest objects), use 'player:harvest(id-nr)' to scan and use/open a object with that given object-id.

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

== Inventory and Item Functions ==

inventory:getItemCount(itemId)

examples:
if( inventory:getItemCount(214536) > 25 ) then
loadPaths("deliver_quest");
end
Get the quantity for a item directly from the games client.

inventory:itemTotalCount(itemNameOrId)
Get the quantity for a item from the cached inventory. You have to be sure, that your inventory is up to date to get the right values. You can use the item-id or the name of the item

inventory:useItem(itemNameOrId)
Use a item from the cached inventory.

inventory:update()
Update the whole inventory from the games client. Depending from you slots, that takes about 10-15 seconds. Nevertheless from using that function, the bot updates the whole inventory at the bot starting time and about 3-4 slots after every fight and about 10-15 slots while the bot is looting.

By default the bot updates slot 1-60. If you want to use more slots please use the profile option
<option name="INV_MAX_SLOTS" value="120" /> 

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is usefull to put that at the first and at the last waypoint if you want to run between two places.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

== Using of RoM API Functions ==
With the function sendMacro() or RoMScript() we can submit macros to the RoM API. Here some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

/script SendSystemChat(tonumber(string.sub(GetBagItemLink(GetBagItemInfo(1)), 8, 12), 16));
Print the itemid of slot-nr 1 into the system chat. Change the slot number to the item you want to get informations about or move that item to slot #1.

sendMacro("GetBagItemCount("..itemid..")")
Get back the quantity of an givem item ID in your bags.

occupiedSlots, totalSlots = sendMacro("GetBagCount();");
Get back the number of total slots in your bag and the number of the occupied slot in your bag.

RoM Variables

2009-10-29T13:27:44Z

D003232:

= Player Variables =

==Player User Fields==
Thats only a small selection of some important variables. Please look at the coding if you want more.

self.free_field1 = nil; -- free field for user use
self.free_field2 = nil; -- free field for user use
self.free_field3 = nil; -- free field for user use
self.free_counter1 = 0; -- free counter for user use
self.free_counter2 = 0; -- free counter for user use
self.free_counter3 = 0; -- free counter for user use
self.free_flag1 = false; -- free flag for user use
self.free_flag2 = false; -- free flag for user use
self.free_flag3 = false; -- free flag for user use

==General Player Fields==
example:<source lang="lua">
if( player.Level > 9 ) then
printf("do some other coding stuff");
end;</source>

player.BotStartTime
player.BotStartTime_nr

Bot start time. 'player.BotStartTime' will be reseted if you pause the bot by pressing 'END'. 'player.BotStartTime_nr' will not be reseted.

<source lang="lua">example:
if( os.difftime(os.time(), player.BotStartTime) > 3600 ) then
printf("do some other coding stuff");
end;</source>

==Player Fight and Target Variables==
player.Fights
Counter for the number of the fights.
<source lang="lua">example:
if( player.Fights-player.free_counter1 > 300 ) then
player.free_counter1 = player.Fights;
loadPaths("l4-5.xml");
end</source>

player.mobs[mobname]
Counter for the number of the fights per mob
<source lang="lua">example:
if( player.mobs["Fungus"] > 25 ) then
printf("do some other coding stuff");
end</source>

= Inventory Variables =

The most inventory fields are accessible by using the inventory functions. Fore more informations about that see the [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions#Inventory_and_Item_Functions inventory function].

RoM Getting started

2009-10-18T12:38:19Z

D003232:

'''Requirements:'''

MicroMacro 1.0, which you can get [http://www.solarstrike.net/phpBB3/viewtopic.php?f=6&t=177 here]

You will need rom scripts and put them in micromacro/scripts folder. here is how you get them:

== Type 1: Downloading rom bot from SVN (recommended but harder) ==
Advanced:

For those of you who already have some working knowledge of SVN, you can use this command to checkout:
svn checkout http://rom-bot.googlecode.com/svn/trunk/ rom-bot-read-only

Simple:

First, I suggest you install Tortoise SVN. Once installed, you may need to reboot your machine. Now, locate your 'rom' folder (should be inside micromacro/scripts/) and right-click it. Select 'SVN Checkout'.

Now, a window should open. Inside "URL of repository:", enter this url:
http://rom-bot.googlecode.com/svn/trunk/rom

Everything else can be left at default. Click OK and it should begin downloading and updating all of your files. Now that you've got it all setup, you can simply right click the 'rom' folder again and select SVN update. Typically, a red icon over the folder should indicate that there are updates to download.

Problems with file conflicts?

This typically happens if you've made any modifications to the scripts. To fix it, you should delete any files that have conflicts, and try to SVN update again.

== Type 2: Downloading rom bot from forums ==
Download [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=163 here]

== Make a path ==
Now you'll need to make a waypoint script. Start MicroMacro and execute the rom/createpath.lua script when prompted. You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

== Configure RoM bot ==
Next you must make a profile. Go to the profile directory and make a copy of Default.xml, but rename it to whatever your character name is. It must be exact, but capitalization shouldn't mater. For the waypoint script option, you will apply the '.xml' extension this time.

To see how to configure your bot, go to [[RoM_Configuration|configuration]]

Heres a video tutorial on configuring your bot. [http://www.youtube.com/watch?v=mUe8g4Eplj4 YouTube link]

== Configure RoM in game ==
In rom, click esc and click interface options, and be sure to have set Turn on Self Cast, Click to move and Auto loot

== Configure the macro ==
Create ingame a empty macro at macro slot 1. You do that by:

Press ESC (System-Menu) -> Macros). Then click at the macro slot 1 at the very up left.

[[Image:macroslot.jpg]]

Press the button 'New' -> 'Save'.

Now move (via Drag&Drop) that empty macro to your action bar button with the defined hotkey from your profile (default key is 0).

'''Tipp to avoid missing keypress:'''
If your bot works in the background and you do some writings in a foreground window, your keypress of modifiers (CTRL/SHIFT/ALT) in the editor will be the cause that sometimes the RoM client receive a CTRL+0 instead of a keypress 0 (if 0 is your hotkey for the macro). To avoid that, it is recommendet to take a second action button and also assign your dummy macro to that second button. After doing that assign the hotkey CTRL+0 and ALT+0 to that second button. Also assign SHIFT+0 to the key 2 for your main MACRO button 0. By doing that you can avoid the miss of keypresses.

== Run ==
Run by starting mircomacro and typing

rom/bot.lua

To see the bot at full work, create a new character (at best a mage or a priest) at the pioneer village and start the bot with

rom/bot.lua profile:l1-10

Then choose path '1-10Pi../l1t_start.xml' from the list. That will level you the character from level 1 to 10 and after doing that run to Varanas class hall (best works mage, priest and scout ... in that order).

I hope this helps! If you see anything i forgot to tell you about, please add it to this wiki page.

RoM Getting started

2009-10-18T12:32:18Z

D003232: Undo revision 331 by 213.190.85.1 (Talk)

QvpvB5 <a href="http://ogqzghpknpuu.com/">ogqzghpknpuu</a>, [url=http://obsdsrinmhla.com/]obsdsrinmhla[/url], [link=http://xdzwzgpbybby.com/]xdzwzgpbybby[/link], http://jbeiikffjwdp.com/

RoM Waypoint file

2009-09-24T14:59:38Z

D003232: /* Waypoint types */

= Working with waypoint files =

== Executing createpath.lua ==
Start MicroMacro and execute the rom/createpath.lua script by entering
rom/createpath.lua
into your MM window. You need a valid profile for your ingame charactername and have to set the dummy macro ingame. You could also execute the script with a forced profile
rom/createpath.lua profile:default

You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

The new created waypointfile boars.xml will look like:

<source lang="xml"><waypoints type="NORMAL" >
<waypoint x="-791" z="-8322"></waypoint>
<waypoint x="-737" z="-8155"></waypoint>
<waypoint x="-552" z="-8251"></waypoint>
<waypoint x="-540" z="-8412"></waypoint>
</waypoints></source>

=== Waypoint types ===

You can determine the targeting and attacking behaviour of the bot by using waypoint types. You can add the 'type' option at the top of the waypoint file or separately for each waypoint. The default value is 'NORMAL'. If you don't specify a type at the waypoint, the waypoint will inherit the type from the <WAYPOINTS> tag at the top of the file

<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-791" z="-8322"></waypoint>
<waypoint x="-737" z="-8155">RUN</waypoint>
<waypoint x="-552" z="-8251">RUN</waypoint>
<waypoint x="-540" z="-8412"></waypoint>
</waypoints></source>In this example, the waypoints #1 and #4 have the type 'TRAVEL' and the waypoints #2 and #3 have the type 'RUN'

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | NORMAL
| style="border-bottom:1px dotted #000000;" | Default value for waypoints. The bot will try to target new mobs and attack them.
|-
| style="border-bottom:1px dotted #000000;" | TRAVEL
| style="border-bottom:1px dotted #000000;" | The bot will not targeting mobs by itself. He will still stand and fight back if he gets aggro.
|-
| style="border-bottom:1px dotted #000000;" | RUN
| style="border-bottom:1px dotted #000000;" | The bot will not targeting mobs and will not stop if he gets aggro. He will just run until he reach a waypoint with one of the other waypoint types or get a stop command within the waypoint coding.
|}

== Using LUA coding with your waypoint files ==

You can insert your own lua code within a waypoint file. The lua code will be executed after you reach that waypoint. Insert the code '''within''' the tags '<waypoint></waypoint>'. It would look like:

<waypoint x="-2462" z="-9625"></waypoint>
<waypoint x="-2391" z="-9639">
if( player.Level > 2 ) then
loadPaths("1-10Pioneers/l3t_3-4_bear");
end
</waypoint>
<waypoint x="-2144" z="-9585"></waypoint>

See the [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions list of functions] that you can use for your own coding.

RoM Waypoint file

2009-09-24T14:54:44Z

D003232:

= Working with waypoint files =

== Executing createpath.lua ==
Start MicroMacro and execute the rom/createpath.lua script by entering
rom/createpath.lua
into your MM window. You need a valid profile for your ingame charactername and have to set the dummy macro ingame. You could also execute the script with a forced profile
rom/createpath.lua profile:default

You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

The new created waypointfile boars.xml will look like:

<source lang="xml"><waypoints type="NORMAL" >
<waypoint x="-791" z="-8322"></waypoint>
<waypoint x="-737" z="-8155"></waypoint>
<waypoint x="-552" z="-8251"></waypoint>
<waypoint x="-540" z="-8412"></waypoint>
</waypoints></source>

=== Waypoint types ===

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | NORMAL
| style="border-bottom:1px dotted #000000;" | Default value for waypoints. The bot will try to target new mobs and attack them.
|-
| style="border-bottom:1px dotted #000000;" | TRAVEL
| style="border-bottom:1px dotted #000000;" | The bot will not targeting mobs by itself. He will still stand and fight back if he gets aggro.
|-
| style="border-bottom:1px dotted #000000;" | RUN
| style="border-bottom:1px dotted #000000;" | The bot will not targeting mobs and will not stop if he gets aggro. He will just run until he reach a waypoint with one of the other waypoint types or get a stop command within the waypoint coding.
|}

== Using LUA coding with your waypoint files ==

You can insert your own lua code within a waypoint file. The lua code will be executed after you reach that waypoint. Insert the code '''within''' the tags '<waypoint></waypoint>'. It would look like:

<waypoint x="-2462" z="-9625"></waypoint>
<waypoint x="-2391" z="-9639">
if( player.Level > 2 ) then
loadPaths("1-10Pioneers/l3t_3-4_bear");
end
</waypoint>
<waypoint x="-2144" z="-9585"></waypoint>

See the [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions list of functions] that you can use for your own coding.

RoM Functions

2009-09-24T14:52:49Z

D003232: /* Waypoint File Functions */

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbags1To10( [[_player_level] , _maxslot] );
open the level 1-10 giftbags and equipt the items.

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

== Player Functions ==
player:harvest();
Scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground).

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

== Inventory and Item Functions ==

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is usefull to put that at the first and at the last waypoint if you want to run between two places.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

== Using of RoM API Functions ==
With the function sendMacro() or RoMScript() we can sumbit macros to the RoM API. Here some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

RoM Waypoint file

2009-09-24T14:51:42Z

D003232: /* Executing createpath.lua */

RoM Waypoint file

2009-09-24T14:51:23Z

D003232: New page: = Working with waypoint files = == Executing createpath.lua == Start MicroMacro and execute the rom/createpath.lua script by entering rom/createpath.lua into your MM window. You need a v...

RoM Bot

2009-09-24T14:42:49Z

D003232:

* [[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 Functions

2009-09-24T14:40:50Z

D003232: /* Waypoint File Functions */

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbags1To10( [[_player_level] , _maxslot] );
open the level 1-10 giftbags and equipt the items.

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

== Player Functions ==
player:harvest();
Scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground).

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

== Inventory and Item Functions ==

== Waypoint File Functions ==

You can insert your own lua code within a waypoint file. The lua code will be executed after you reach that waypoint. Insert the code '''within''' the tags '<waypoint></waypoint>'. It would look like:

<waypoint x="-2462" z="-9625"></waypoint>
<waypoint x="-2391" z="-9639">
if( player.Level > 2 ) then
loadPaths("1-10Pioneers/l3t_3-4_bear");
end
</waypoint>
<waypoint x="-2144" z="-9585"></waypoint>

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is usefull to put that at the first and at the last waypoint if you want to run between two places.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

== Using of RoM API Functions ==
With the function sendMacro() or RoMScript() we can sumbit macros to the RoM API. Here some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

RoM Leveling

2009-09-22T14:01:28Z

D003232: /* Automatic Level of Skills from 1 - 10 */

= Example Files from 1 - 10 =

There are example files for leveling from 1 - 10 in the profile folder. Just start the bot with
rom/bot.lua profile:l1-10
After doing that select the waypointfile 'l1_goto_2.xml' from the list.

Best classes for a fast leveling are at first mage and at second priest. The other classes will also come to a finish. But they would normaly need a new weapoin while leveling. To do the way from level 1 to 10 with the beginners level 1 weapon is a little annoying.

It is recommented that you copy that files and change the paths. Simply because of running to much people the same path will look very bottish and could result into an accout ban.

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag();
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintained the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and levelup a skill by skill parameters.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =

== Automatic Open Bags from 1 - 10 ==

openGiftbags1To10( [player.Level [, maxslot] );

That function knows the giftbags from 1 - 10, opens them and equipt the armor from within. Just enter that function within your onLevelup event into your profile.

== Open Bags with the bot inventory functions ==

inventory:useItem( itemid | itemname );

To be sure, your inventory knows all items. You should do a full inventory update after levelup

inventory:update();

RoM Configuration

2009-09-17T15:40:25Z

D003232: /* Profile - Skills */

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="DEBUG_ASSERT" 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", and "french".
|-
| style="border-bottom:1px dotted #000000;" | DEBUG_ASSERT
| 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 - 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;" | 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===

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 Getting started

2009-09-17T08:37:04Z

D003232: /* Configure the macro */

'''Requirements:'''

MicroMacro 1.0, which you can get [http://www.solarstrike.net/phpBB3/viewtopic.php?f=6&t=177 here]

You will need rom scripts and put them in micromacro/scripts folder. here is how you get them:

== Type 1: Downloading rom bot from SVN (recommended but harder) ==
Advanced:

For those of you who already have some working knowledge of SVN, you can use this command to checkout:
svn checkout http://rom-bot.googlecode.com/svn/trunk/ rom-bot-read-only

Simple:

First, I suggest you install Tortoise SVN. Once installed, you may need to reboot your machine. Now, locate your 'rom' folder (should be inside micromacro/scripts/) and right-click it. Select 'SVN Checkout'.

Now, a window should open. Inside "URL of repository:", enter this url:
http://rom-bot.googlecode.com/svn/trunk/rom

Everything else can be left at default. Click OK and it should begin downloading and updating all of your files. Now that you've got it all setup, you can simply right click the 'rom' folder again and select SVN update. Typically, a red icon over the folder should indicate that there are updates to download.

Problems with file conflicts?

This typically happens if you've made any modifications to the scripts. To fix it, you should delete any files that have conflicts, and try to SVN update again.

== Type 2: Downloading rom bot from forums ==
Download [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=163 here]

== Make a path ==
Now you'll need to make a waypoint script. Start MicroMacro and execute the rom/createpath.lua script when prompted. You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

== Configure RoM bot ==
Next you must make a profile. Go to the profile directory and make a copy of Default.xml, but rename it to whatever your character name is. It must be exact, but capitalization shouldn't mater. For the waypoint script option, you will apply the '.xml' extension this time.

To see how to configure your bot, go to [[RoM_Configuration|configuration]]

Heres a video tutorial on configuring your bot. [http://www.youtube.com/watch?v=mUe8g4Eplj4 YouTube link]

== Configure RoM in game ==
In rom, click esc and click interface options, and be sure to have set Turn on Self Cast, Click to move and Auto loot

== Configure the macro ==
Create ingame a empty macro at macro slot 1. You do that by:

Press ESC (System-Menu) -> Macros). Then click at the macro slot 1 at the very up left.

[[Image:macroslot.jpg]]

Press the button 'New' -> 'Save'.

Now move (via Drag&Drop) that empty macro to your action bar button with the defined hotkey from your profile (default key is 0).

== Run ==
Run by starting mircomacro and typing

rom/bot.lua

To see the bot at full work, create a new character (at best a mage or a priest) at the pioneer village and start the bot with

rom/bot.lua profile:l1-10

Then choose path '1-10Pi../l1t_start.xml' from the list. That will level you the character from level 1 to 10 and after doing that run to Varanas class hall (best works mage, priest and scout ... in that order).

I hope this helps! If you see anything i forgot to tell you about, please add it to this wiki page.

RoM Getting started

2009-09-17T08:36:10Z

D003232: /* Configure the macro */

'''Requirements:'''

MicroMacro 1.0, which you can get [http://www.solarstrike.net/phpBB3/viewtopic.php?f=6&t=177 here]

You will need rom scripts and put them in micromacro/scripts folder. here is how you get them:

== Type 1: Downloading rom bot from SVN (recommended but harder) ==
Advanced:

For those of you who already have some working knowledge of SVN, you can use this command to checkout:
svn checkout http://rom-bot.googlecode.com/svn/trunk/ rom-bot-read-only

Simple:

First, I suggest you install Tortoise SVN. Once installed, you may need to reboot your machine. Now, locate your 'rom' folder (should be inside micromacro/scripts/) and right-click it. Select 'SVN Checkout'.

Now, a window should open. Inside "URL of repository:", enter this url:
http://rom-bot.googlecode.com/svn/trunk/rom

Everything else can be left at default. Click OK and it should begin downloading and updating all of your files. Now that you've got it all setup, you can simply right click the 'rom' folder again and select SVN update. Typically, a red icon over the folder should indicate that there are updates to download.

Problems with file conflicts?

This typically happens if you've made any modifications to the scripts. To fix it, you should delete any files that have conflicts, and try to SVN update again.

== Type 2: Downloading rom bot from forums ==
Download [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=163 here]

== Make a path ==
Now you'll need to make a waypoint script. Start MicroMacro and execute the rom/createpath.lua script when prompted. You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

== Configure RoM bot ==
Next you must make a profile. Go to the profile directory and make a copy of Default.xml, but rename it to whatever your character name is. It must be exact, but capitalization shouldn't mater. For the waypoint script option, you will apply the '.xml' extension this time.

To see how to configure your bot, go to [[RoM_Configuration|configuration]]

Heres a video tutorial on configuring your bot. [http://www.youtube.com/watch?v=mUe8g4Eplj4 YouTube link]

== Configure RoM in game ==
In rom, click esc and click interface options, and be sure to have set Turn on Self Cast, Click to move and Auto loot

== Configure the macro ==
Create ingame a empty macro at macro slot 1. You do that by:

Press ESC (System-Menu) -> Macros). Then click at the macro slot 1 at the very up left.

[[Image:macroslot.jpg]]

Press the button 'New' -> 'Save'.

Now move that empty macro to your action button with the defined hotkey from your profile (default key is 0).

== Run ==
Run by starting mircomacro and typing

rom/bot.lua

To see the bot at full work, create a new character (at best a mage or a priest) at the pioneer village and start the bot with

rom/bot.lua profile:l1-10

Then choose path '1-10Pi../l1t_start.xml' from the list. That will level you the character from level 1 to 10 and after doing that run to Varanas class hall (best works mage, priest and scout ... in that order).

I hope this helps! If you see anything i forgot to tell you about, please add it to this wiki page.

RoM Getting started

2009-09-16T09:56:22Z

D003232: /* Run */

'''Requirements:'''

MicroMacro 1.0, which you can get [http://www.solarstrike.net/phpBB3/viewtopic.php?f=6&t=177 here]

You will need rom scripts and put them in micromacro/scripts folder. here is how you get them:

== Type 1: Downloading rom bot from SVN (recommended but harder) ==
Advanced:

For those of you who already have some working knowledge of SVN, you can use this command to checkout:
svn checkout http://rom-bot.googlecode.com/svn/trunk/ rom-bot-read-only

Simple:

First, I suggest you install Tortoise SVN. Once installed, you may need to reboot your machine. Now, locate your 'rom' folder (should be inside micromacro/scripts/) and right-click it. Select 'SVN Checkout'.

Now, a window should open. Inside "URL of repository:", enter this url:
http://rom-bot.googlecode.com/svn/trunk/rom

Everything else can be left at default. Click OK and it should begin downloading and updating all of your files. Now that you've got it all setup, you can simply right click the 'rom' folder again and select SVN update. Typically, a red icon over the folder should indicate that there are updates to download.

Problems with file conflicts?

This typically happens if you've made any modifications to the scripts. To fix it, you should delete any files that have conflicts, and try to SVN update again.

== Type 2: Downloading rom bot from forums ==
Download [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=163 here]

== Make a path ==
Now you'll need to make a waypoint script. Start MicroMacro and execute the rom/createpath.lua script when prompted. You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

== Configure RoM bot ==
Next you must make a profile. Go to the profile directory and make a copy of Default.xml, but rename it to whatever your character name is. It must be exact, but capitalization shouldn't mater. For the waypoint script option, you will apply the '.xml' extension this time.

To see how to configure your bot, go to [[RoM_Configuration|configuration]]

Heres a video tutorial on configuring your bot. [http://www.youtube.com/watch?v=mUe8g4Eplj4 YouTube link]

== Configure RoM in game ==
In rom, click esc and click interface options, and be sure to have set Turn on Self Cast, Click to move and Auto loot

== Configure the macro ==
Set MACRO key to default 0 key

[[Image:macroslot.jpg]]

== Run ==
Run by starting mircomacro and typing

rom/bot.lua

To see the bot at full work, create a new character (at best a mage or a priest) at the pioneer village and start the bot with

rom/bot.lua profile:l1-10

Then choose path '1-10Pi../l1t_start.xml' from the list. That will level you the character from level 1 to 10 and after doing that run to Varanas class hall (best works mage, priest and scout ... in that order).

I hope this helps! If you see anything i forgot to tell you about, please add it to this wiki page.

RoM Functions

2009-09-13T09:23:42Z

D003232: /* General Functions */

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbags1To10( [[_player_level] , _maxslot] );
open the level 1-10 giftbags and equipt the items.

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

== Player Functions ==
player:harvest();
Scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground).

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

== Inventory and Item Functions ==

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is usefull to put that at the first and at the last waypoint if you want to run between two places.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

== Using of RoM API Functions ==
With the function sendMacro() or RoMScript() we can sumbit macros to the RoM API. Here some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

RoM Leveling

2009-09-13T09:22:53Z

D003232: /* Automatic Open Bags from 1 - 10 */

= Example Files from 1 - 10 =

There are example files for leveling from 1 - 10 in the profile folder. Just start the bot with
rom/bot.lua profile:l1-10
After doing that select the waypointfile 'l1_goto_2.xml' from the list.

Best classes for a fast leveling are at first mage and at second priest. The other classes will also come to a finish. But they would normaly need a new weapoin while leveling. To do the way from level 1 to 10 with the beginners level 1 weapon is a little annoying.

It is recommented that you copy that files and change the paths. Simply because of running to much people the same path will look very bottish and could result into an accout ban.

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag(player.Level, 18);
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintained the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and levelup a skill by skill parameters.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =

== Automatic Open Bags from 1 - 10 ==

openGiftbags1To10( [player.Level [, maxslot] );

That function knows the giftbags from 1 - 10, opens them and equipt the armor from within. Just enter that function within your onLevelup event into your profile.

== Open Bags with the bot inventory functions ==

inventory:useItem( itemid | itemname );

To be sure, your inventory knows all items. You should do a full inventory update after levelup

inventory:update();

RoM Leveling

2009-09-13T00:03:57Z

D003232: /* Levelup a Single Skill by Name */

= Example Files from 1 - 10 =

There are example files for leveling from 1 - 10 in the profile folder. Just start the bot with
rom/bot.lua profile:l1-10
After doing that select the waypointfile 'l1_goto_2.xml' from the list.

Best classes for a fast leveling are at first mage and at second priest. The other classes will also come to a finish. But they would normaly need a new weapoin while leveling. To do the way from level 1 to 10 with the beginners level 1 weapon is a little annoying.

It is recommented that you copy that files and change the paths. Simply because of running to much people the same path will look very bottish and could result into an accout ban.

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag(player.Level, 18);
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintained the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and levelup a skill by skill parameters.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =

== Automatic Open Bags from 1 - 10 ==

openGiftbag( [player.Level [, maxslot] );

That function knows the giftbags from 1 - 10, opens them and equipt the armor from within. Just enter that function within your onLevelup event into your profile.

== Open Bags with the bot inventory functions ==

inventory:useItem( itemid | itemname );

To be sure, your inventory knows all items. You should do a full inventory update after levelup

inventory:update();

RoM Leveling

2009-09-13T00:03:43Z

D003232: /* Levelup a Single Skill by Name */

= Example Files from 1 - 10 =

There are example files for leveling from 1 - 10 in the profile folder. Just start the bot with
rom/bot.lua profile:l1-10
After doing that select the waypointfile 'l1_goto_2.xml' from the list.

Best classes for a fast leveling are at first mage and at second priest. The other classes will also come to a finish. But they would normaly need a new weapoin while leveling. To do the way from level 1 to 10 with the beginners level 1 weapon is a little annoying.

It is recommented that you copy that files and change the paths. Simply because of running to much people the same path will look very bottish and could result into an accout ban.

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag(player.Level, 18);
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintained the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and levelup a skill by using parameters.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =

== Automatic Open Bags from 1 - 10 ==

openGiftbag( [player.Level [, maxslot] );

That function knows the giftbags from 1 - 10, opens them and equipt the armor from within. Just enter that function within your onLevelup event into your profile.

== Open Bags with the bot inventory functions ==

inventory:useItem( itemid | itemname );

To be sure, your inventory knows all items. You should do a full inventory update after levelup

inventory:update();

RoM Leveling

2009-09-13T00:03:07Z

D003232: /* Levelup a Single Skill by Name */

= Example Files from 1 - 10 =

There are example files for leveling from 1 - 10 in the profile folder. Just start the bot with
rom/bot.lua profile:l1-10
After doing that select the waypointfile 'l1_goto_2.xml' from the list.

Best classes for a fast leveling are at first mage and at second priest. The other classes will also come to a finish. But they would normaly need a new weapoin while leveling. To do the way from level 1 to 10 with the beginners level 1 weapon is a little annoying.

It is recommented that you copy that files and change the paths. Simply because of running to much people the same path will look very bottish and could result into an accout ban.

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag(player.Level, 18);
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintained the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =

== Automatic Open Bags from 1 - 10 ==

openGiftbag( [player.Level [, maxslot] );

That function knows the giftbags from 1 - 10, opens them and equipt the armor from within. Just enter that function within your onLevelup event into your profile.

== Open Bags with the bot inventory functions ==

inventory:useItem( itemid | itemname );

To be sure, your inventory knows all items. You should do a full inventory update after levelup

inventory:update();

RoM Leveling

2009-09-12T21:58:26Z

D003232: /* Example Files from 1 - 10 */

= Example Files from 1 - 10 =

There are example files for leveling from 1 - 10 in the profile folder. Just start the bot with
rom/bot.lua profile:l1-10
After doing that select the waypointfile 'l1_goto_2.xml' from the list.

Best classes for a fast leveling are at first mage and at second priest. The other classes will also come to a finish. But they would normaly need a new weapoin while leveling. To do the way from level 1 to 10 with the beginners level 1 weapon is a little annoying.

It is recommented that you copy that files and change the paths. Simply because of running to much people the same path will look very bottish and could result into an accout ban.

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag(player.Level, 18);
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =

== Automatic Open Bags from 1 - 10 ==

openGiftbag( [player.Level [, maxslot] );

That function knows the giftbags from 1 - 10, opens them and equipt the armor from within. Just enter that function within your onLevelup event into your profile.

== Open Bags with the bot inventory functions ==

inventory:useItem( itemid | itemname );

To be sure, your inventory knows all items. You should do a full inventory update after levelup

inventory:update();

RoM Functions

2009-09-12T21:30:57Z

D003232: /* General Functions */

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbag( [[_player_level] , _maxslot] );
open giftbag (at the moment level 1-10) and equipt the items

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

== Player Functions ==
player:harvest();
Scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground).

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

== Inventory and Item Functions ==

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is usefull to put that at the first and at the last waypoint if you want to run between two places.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

== Using of RoM API Functions ==
With the function sendMacro() or RoMScript() we can sumbit macros to the RoM API. Here some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

RoM Leveling

2009-09-12T21:27:13Z

D003232:

= Example Files from 1 - 10 =

There are example files for leveling from 1 - 10 in the profile folder. Just start the bot with
rom/bot.lua profile:l1-10
After doing that select the waypointfile 'l1_goto_2.xml' from the list.

It is recommented that you copy that files and change the paths. Simply because of running to much people the same path will look very bottish and could result into an accout ban.

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag(player.Level, 18);
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =

== Automatic Open Bags from 1 - 10 ==

openGiftbag( [player.Level [, maxslot] );

That function knows the giftbags from 1 - 10, opens them and equipt the armor from within. Just enter that function within your onLevelup event into your profile.

== Open Bags with the bot inventory functions ==

inventory:useItem( itemid | itemname );

To be sure, your inventory knows all items. You should do a full inventory update after levelup

inventory:update();

RoM Leveling

2009-09-12T21:13:03Z

D003232: /* Automatic Open Bags from 1 - 10 */

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag(player.Level, 18);
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =

== Automatic Open Bags from 1 - 10 ==

openGiftbag( [player.Level [, maxslot] );

That function knows the giftbags from 1 - 10, opens them and equipt the armor from within. Just enter that function within your onLevelup event into your profile.

== Open Bags with the bot inventory functions ==

inventory:useItem( itemid | itemname );

To be sure, your inventory knows all items. You should do a full inventory update after levelup

inventory:update();

RoM Leveling

2009-09-12T21:12:16Z

D003232: /* Open Bags And Equipt Armor */

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag(player.Level, 18);
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =

== Automatic Open Bags from 1 - 10 ==

openGiftbag(player.Level, 18);

That function knows the giftbags from 1 - 10, opens them and equipt the armor from within. Just enter that function within your onLevelup event into your profile.

== Open Bags with the bot inventory functions ==

inventory:useItem( itemid | itemname );

To be sure, your inventory knows all items. You should do a full inventory update after levelup

inventory:update();

RoM Leveling

2009-09-12T21:03:09Z

D003232: /* Automatic Skill Leveling */

= Connecting waypoint files =

For automatic leveling, you have to connect different waypoint files. Starting from one waypoint file, you change to the next, if you reach a given level.

You start at the spawn point in Pionier Village and walk to your first botting place:
<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>If you reach your first botting place, you load the waypoint file for that place with the command
<source lang="lua">load_paths( [waypointfile] | [returnpath] );</source>
You can do that also if you reach a given level, to go to the next botting place:
<source lang="xml"> <waypoint x="-1931" z="-9750">
if( player.Level > 4) then
load_paths("l5-6.xml");
end
</waypoint></source>

= Automatic Skill Leveling =
Use the <onLevelup> event in your profile to automatic level up your skills

== Automatic Level of Skills from 1 - 10 ==

<source lang="lua"><onLevelup>
levelupSkills1To10();
</onLevelup></source>

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

<source lang="lua"> <onLoad>
-- Additional Lua code to execute after loading the profile
-- and before the bot starts. e.g. You could overwrite profile settings here
-- like: changeProfileOption("HP_REST", 60);

if(player.Level == 1) then
openGiftbag(player.Level, 18);
else
levelupSkills1To10("loadonly");
end;

</onLoad>
</source>

== Levelup a Single Skill by Name ==

<source lang="lua">
levelupSkill(_skillname [, _times] )
</source>
For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

== Levelup a Single Skill by Skill Parameters ==
For doing it that way, you have to determine the skill tab and skill number by yourself.
<source lang="lua"><onLevelup>
if( player.Level == 26 ) then
send_macro("SetSpellPoint( 4, 2 );");
end
</onLevelup></source>If you want to test the skill numbers you need, you can enter the following script into the ingame chat. It will print the skill name for the selected skill number into the chat.

<source lang="lua">/script _SkillName = GetSkillDetail(4,2); SendSystemChat(_SkillName);</source>
The first number means the tab from the skill book. Numer 4 addresses the third tab. :-) The second number is the number of the skill on that page.

= Open Bags And Equipt Armor =
You can automaticly open the present bags and equipt armor from the bags.

'''That's an example what you can do now. That funtionality will change within the bot in the next time.'''

<source lang="lua"><onLeaveCombat>
if( player.Level > player.free_counter1 and
player.Level == 2 ) then yrest(2000);
yrest(1000);
send_macro("UseBagItem( CheckForItem('Abenteurer-Geschenkbeutel') )");
yrest(3000);
send_macro("UseBagItem( CheckForItem('Stoffg\195\188rtel (Geschenk des Pionierdorfs)') )");
player.free_counter1 = player.Level;
send_macro("SetSpellPoint( 4, 2 );");
yrest(1000);
send_macro("SetSpellPoint( 4, 2 );");
elseif( player.Level > player.free_counter1 and
player.Level == 3 ) then yrest(2000);
send_macro("UseBagItem( CheckForItem('Pionier-Geschenkbeutel') )");
yrest(2000);
send_macro("UseBagItem( CheckForItem('Ohrringe (Geschenk des Pionierdorfs)') )");
player.free_counter1 = player.Level;
send_macro("SetSpellPoint( 4, 2 );");
end
</onLeaveCombat></source>
In that example we use a new ingame macro function [http://forum.runesofmagic.com/showthread.php?t=62431&page=2 CheckForItem] for selecting an ingame item by name. You have to download that small lua file and install it within your addon folder.

RoM Getting started

2009-09-11T18:48:27Z

D003232: /* Run */

'''Requirements:'''

MicroMacro 1.0, which you can get [http://www.solarstrike.net/phpBB3/viewtopic.php?f=6&t=177 here]

You will need rom scripts and put them in micromacro/scripts folder. here is how you get them:

== Type 1: Downloading rom bot from SVN (recommended but harder) ==
Advanced:

For those of you who already have some working knowledge of SVN, you can use this command to checkout:
svn checkout http://rom-bot.googlecode.com/svn/trunk/ rom-bot-read-only

Simple:

First, I suggest you install Tortoise SVN. Once installed, you may need to reboot your machine. Now, locate your 'rom' folder (should be inside micromacro/scripts/) and right-click it. Select 'SVN Checkout'.

Now, a window should open. Inside "URL of repository:", enter this url:
http://rom-bot.googlecode.com/svn/trunk/rom

Everything else can be left at default. Click OK and it should begin downloading and updating all of your files. Now that you've got it all setup, you can simply right click the 'rom' folder again and select SVN update. Typically, a red icon over the folder should indicate that there are updates to download.

Problems with file conflicts?

This typically happens if you've made any modifications to the scripts. To fix it, you should delete any files that have conflicts, and try to SVN update again.

== Type 2: Downloading rom bot from forums ==
Download [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=163 here]

== Make a path ==
Now you'll need to make a waypoint script. Start MicroMacro and execute the rom/createpath.lua script when prompted. You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

== Configure RoM bot ==
Next you must make a profile. Go to the profile directory and make a copy of Default.xml, but rename it to whatever your character name is. It must be exact, but capitalization shouldn't mater. For the waypoint script option, you will apply the '.xml' extension this time.

To see how to configure your bot, go to [[RoM_Configuration|configuration]]

Heres a video tutorial on configuring your bot. [http://www.youtube.com/watch?v=mUe8g4Eplj4 YouTube link]

== Configure RoM in game ==
In rom, click esc and click interface options, and be sure to have set Turn on Self Cast, Click to move and Auto loot

== Configure the macro ==
Set MACRO key to default 0 key

[[Image:macroslot.jpg]]

== Run ==
Run by starting mircomacro and typing

rom/bot.lua

To see the bot at full work, create a new character (at best a mage or a priest) at the pioneer village and start the bot with

rom/bot.lua profile:l1-10

Then choose path 'l1_goto_2.xml' from the list. That will level you the character from level 1 to 10 and after doing that run to Varanas class hall.

I hope this helps! If you see anything i forgot to tell you about, please add it to this wiki page.

RoM Getting started

2009-09-11T18:48:10Z

D003232: /* Run */

'''Requirements:'''

MicroMacro 1.0, which you can get [http://www.solarstrike.net/phpBB3/viewtopic.php?f=6&t=177 here]

You will need rom scripts and put them in micromacro/scripts folder. here is how you get them:

== Type 1: Downloading rom bot from SVN (recommended but harder) ==
Advanced:

For those of you who already have some working knowledge of SVN, you can use this command to checkout:
svn checkout http://rom-bot.googlecode.com/svn/trunk/ rom-bot-read-only

Simple:

First, I suggest you install Tortoise SVN. Once installed, you may need to reboot your machine. Now, locate your 'rom' folder (should be inside micromacro/scripts/) and right-click it. Select 'SVN Checkout'.

Now, a window should open. Inside "URL of repository:", enter this url:
http://rom-bot.googlecode.com/svn/trunk/rom

Everything else can be left at default. Click OK and it should begin downloading and updating all of your files. Now that you've got it all setup, you can simply right click the 'rom' folder again and select SVN update. Typically, a red icon over the folder should indicate that there are updates to download.

Problems with file conflicts?

This typically happens if you've made any modifications to the scripts. To fix it, you should delete any files that have conflicts, and try to SVN update again.

== Type 2: Downloading rom bot from forums ==
Download [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=163 here]

== Make a path ==
Now you'll need to make a waypoint script. Start MicroMacro and execute the rom/createpath.lua script when prompted. You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

== Configure RoM bot ==
Next you must make a profile. Go to the profile directory and make a copy of Default.xml, but rename it to whatever your character name is. It must be exact, but capitalization shouldn't mater. For the waypoint script option, you will apply the '.xml' extension this time.

To see how to configure your bot, go to [[RoM_Configuration|configuration]]

Heres a video tutorial on configuring your bot. [http://www.youtube.com/watch?v=mUe8g4Eplj4 YouTube link]

== Configure RoM in game ==
In rom, click esc and click interface options, and be sure to have set Turn on Self Cast, Click to move and Auto loot

== Configure the macro ==
Set MACRO key to default 0 key

[[Image:macroslot.jpg]]

== Run ==
Run by starting mircomacro and typing

rom/bot.lua

To see the bot at full work, create a new character (at best a mage or ariest) at the pioneer village and start the bot with

rom/bot.lua profile:l1-10

Then choose path 'l1_goto_2.xml' from the list. That will level you the character from level 1 to 10 and after doing that run to Varanas class hall.

I hope this helps! If you see anything i forgot to tell you about, please add it to this wiki page.

RoM Getting started

2009-09-10T16:42:19Z

D003232: /* Run */

'''Requirements:'''

MicroMacro 1.0, which you can get [http://www.solarstrike.net/phpBB3/viewtopic.php?f=6&t=177 here]

You will need rom scripts and put them in micromacro/scripts folder. here is how you get them:

== Type 1: Downloading rom bot from SVN (recommended but harder) ==
Advanced:

For those of you who already have some working knowledge of SVN, you can use this command to checkout:
svn checkout http://rom-bot.googlecode.com/svn/trunk/ rom-bot-read-only

Simple:

First, I suggest you install Tortoise SVN. Once installed, you may need to reboot your machine. Now, locate your 'rom' folder (should be inside micromacro/scripts/) and right-click it. Select 'SVN Checkout'.

Now, a window should open. Inside "URL of repository:", enter this url:
http://rom-bot.googlecode.com/svn/trunk/rom

Everything else can be left at default. Click OK and it should begin downloading and updating all of your files. Now that you've got it all setup, you can simply right click the 'rom' folder again and select SVN update. Typically, a red icon over the folder should indicate that there are updates to download.

Problems with file conflicts?

This typically happens if you've made any modifications to the scripts. To fix it, you should delete any files that have conflicts, and try to SVN update again.

== Type 2: Downloading rom bot from forums ==
Download [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=163 here]

== Make a path ==
Now you'll need to make a waypoint script. Start MicroMacro and execute the rom/createpath.lua script when prompted. You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

== Configure RoM bot ==
Next you must make a profile. Go to the profile directory and make a copy of Default.xml, but rename it to whatever your character name is. It must be exact, but capitalization shouldn't mater. For the waypoint script option, you will apply the '.xml' extension this time.

To see how to configure your bot, go to [[RoM_Configuration|configuration]]

Heres a video tutorial on configuring your bot. [http://www.youtube.com/watch?v=mUe8g4Eplj4 YouTube link]

== Configure RoM in game ==
In rom, click esc and click interface options, and be sure to have set Turn on Self Cast, Click to move and Auto loot

== Configure the macro ==
Set MACRO key to default 0 key

[[Image:macroslot.jpg]]

== Run ==
Run by starting mircomacro and typing

rom/bot.lua

To see the bot at full work, create a new character (at best a mage) at the pioneer village and start the bot with

rom/bot.lua profile:l1-10

Then choose path 'l1_goto_2.xml' from the list. That will level you the character from level 1 to 10 and after doing that run to Varanas class hall.

I hope this helps! If you see anything i forgot to tell you about, please add it to this wiki page.

RoM Configuration

2009-09-10T08:51:25Z

D003232: /* Character Profiles */

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="DEBUG_ASSERT" 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", and "french".
|-
| style="border-bottom:1px dotted #000000;" | DEBUG_ASSERT
| 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 - 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. This will over-ride HP_LOW for heals!
|-
| 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;" | 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===

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-09-10T08:42:05Z

D003232: /* Profile - Hotkeys */

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="DEBUG_ASSERT" 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", and "french".
|-
| style="border-bottom:1px dotted #000000;" | DEBUG_ASSERT
| 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===
{|
|-
| 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>

===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. This will over-ride HP_LOW for heals!
|-
| 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;" | 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===

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-09-10T08:39:18Z

D003232:

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="DEBUG_ASSERT" 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", and "french".
|-
| style="border-bottom:1px dotted #000000;" | DEBUG_ASSERT
| 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===
{|
|-
| 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>

===Profile - Hotkeys===
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. This will over-ride HP_LOW for heals!
|-
| 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;" | 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===

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-09-10T08:34:13Z

D003232: /* Profile - Hotkeys */

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="DEBUG_ASSERT" 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", and "french".
|-
| style="border-bottom:1px dotted #000000;" | DEBUG_ASSERT
| 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===
{|
|-
| 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>

===Profile - Hotkeys===
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. This will over-ride HP_LOW for heals!
|-
| 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;" | 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.

RoM Functions

2009-09-10T08:28:25Z

D003232: /* Using of RoM API Functions */

RoM Functions

2009-09-10T08:28:03Z

D003232: