Difference between revisions of "pickupitems.txt"

From OpenKore Wiki
Jump to navigation Jump to search
(Created page with 'If the option itemsTakeAuto or itemsGatherAuto in config.txt is enabled, Kore will automatically pick up loots. However, Kore will not automatically pick up items unless you …')
 
 
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
If the option itemsTakeAuto or itemsGatherAuto in [[config.txt]] is enabled, Kore will automatically pick up loots. However, Kore will not automatically pick up items unless you specify them in the file pickupitems.txt.  
+
Per-item settings for [[itemsTakeAuto|picking up]] and [[itemsGatherAuto|gathering]] items.
  
==Syntax==
+
Empty configuration will result in not picking up any items.
 +
 
 +
== Syntax ==
 
The format of this file is simply a set of lines that observes the following syntax:
 
The format of this file is simply a set of lines that observes the following syntax:
<item name> <pickup flag>
 
  
==Details==
+
<item_name or item_id> <value>
===<item name>===
 
This is the simple name of an item. You can use the keyword "all" to set the default option for all items.
 
  
'''Notes:'''  
+
; <[[References#Item_Names|item_name or item_id]]>
* Kore can see unidentified items, so just use normal item names as if they are already identified.
+
: This is the simple name of an item. Keyword "all" can be used to set the default value for '''all''' items not specified in configuration. You can also specify the ID of the item.
* Specify item names without the refine level and compounded cards. For example, if you specified to pick up Stiletto [3], it will pick up all 3-slotted Stilettos, including +9 3-slotted Stilettos and Triple Hurricane Stilettos.  
+
 
 +
; <value>
 +
: Determines picking up and gathering behavior for specified item.
  
===<pickup flag>===
+
{|class="TablePager"
This is a flag that controls if Kore should pick up the item or not. It takes one of the following values:
 
{| class="wikitable" border="1"
 
!Value!!Description
 
 
|-
 
|-
|align=center|-1||Drop the item when it enters your inventory.
+
!Value
 +
!Description
 
|-
 
|-
|align=center|0||Do not pick up the item.
+
!-1
 +
|Drop the item when it enters your inventory.
 
|-
 
|-
|align=center|1||Pick up the item.
+
!0
 +
|Don't pick up / gather the item.
 
|-
 
|-
|align=center|2||Pick up the item as fast as possible (don't use this on normal, seemingly worthless, items).  
+
!1
 +
|Pick up / gather the item using normal [[itemsTakeAuto|picking up]] and [[itemsGatherAuto|gathering]] sequences.
 +
|-
 +
!>=2
 +
|Try to pick up / gather the item as fast as possible when it appears in 5 cell distance around you.
 
|}
 
|}
  
==Examples==
+
== Notes ==
In the following example, kore will pick up Old Blue Boxes and 2-slotted Two-handed Axes as quickly as possible. It will ignore 3-slotted Axes, Traps and Magnifiers and drop those items when they are in the inventory. All other items will be picked up by default.  
+
* Kore can see unidentified items, so just use normal item names as if they are already identified.
 +
* Specify item names without the refine level and compounded cards (simple names). For example, if you specified to pick up "Stiletto [3]", it will pick up all 3-slotted Stilettos, including "+9 3-slotted Stilettos" and "Triple Hurricane Stilettos".
 +
* Value '''-1''' is useful for Rogues with [http://irowiki.org/wiki/Gank Gank] skill.
 +
* Don't use value '''2''' on normal, seemingly worthless, items.
 +
 
 +
== API ==
 +
<code>Misc::pickupitems</code>
 +
 
 +
== Examples ==
 +
In the following example, kore will pick up ''Old Blue Boxes'' and 2-slotted ''Two-handed Axes'' as quickly as possible. It will ignore 3-slotted ''Axes'', Magnifiers  and Arrows (ID 1750) and drop those items when they are in the inventory. All other items will be picked up by default.  
 +
 
 
  Old Blue Box 2
 
  Old Blue Box 2
 
  Two-handed Axe [2] 2
 
  Two-handed Axe [2] 2
 
  Axe [3] -1
 
  Axe [3] -1
 
  Magnifier -1
 
  Magnifier -1
  Trap -1
+
  1750 -1 # Arrow
 
   
 
   
 
  #Pick up all items by default
 
  #Pick up all items by default
 
  all 1
 
  all 1
  
'''''Note.''''' Lines that begin with the pound sign (#) are comment lines. They are ignored by Openkore.
+
 
 +
[[Category:control]]

Latest revision as of 23:49, 26 April 2021

Per-item settings for picking up and gathering items.

Empty configuration will result in not picking up any items.

Syntax

The format of this file is simply a set of lines that observes the following syntax:

<item_name or item_id> <value>
<item_name or item_id>
This is the simple name of an item. Keyword "all" can be used to set the default value for all items not specified in configuration. You can also specify the ID of the item.
<value>
Determines picking up and gathering behavior for specified item.
Value Description
-1 Drop the item when it enters your inventory.
0 Don't pick up / gather the item.
1 Pick up / gather the item using normal picking up and gathering sequences.
>=2 Try to pick up / gather the item as fast as possible when it appears in 5 cell distance around you.

Notes

  • Kore can see unidentified items, so just use normal item names as if they are already identified.
  • Specify item names without the refine level and compounded cards (simple names). For example, if you specified to pick up "Stiletto [3]", it will pick up all 3-slotted Stilettos, including "+9 3-slotted Stilettos" and "Triple Hurricane Stilettos".
  • Value -1 is useful for Rogues with Gank skill.
  • Don't use value 2 on normal, seemingly worthless, items.

API

Misc::pickupitems

Examples

In the following example, kore will pick up Old Blue Boxes and 2-slotted Two-handed Axes as quickly as possible. It will ignore 3-slotted Axes, Magnifiers and Arrows (ID 1750) and drop those items when they are in the inventory. All other items will be picked up by default.

Old Blue Box 2
Two-handed Axe [2] 2
Axe [3] -1
Magnifier -1
1750 -1 # Arrow

#Pick up all items by default
all 1