items control.txt: Difference between revisions

From OpenKore Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
The file '''items_control.txt''' allows you to automatically manage items in your inventory. If you are using [[storageAuto]] and/or [[sellAuto]], this gives you control over which items to put in storage and which items to sell. It also has features for automatically transfering items to and from your cart.
The file '''items_control.txt''' allows you to automatically manage items in your inventory. If you are using [[storageAuto]] and/or [[sellAuto]], this gives you control over which items to put in storage and which items to sell. It also has features for automatically transfering items to and from your cart.


All data in this file is case-insensitive.


== Syntax ==
== 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> <minimum> <storage> <sell> <cart add> <cart get>
  <item name> <minimum> <auto-store> <auto-sell> [put in cart] [get from car]


=== Details ===
=== <[[References#Item_Names|item name]]> ===
 
; <[[References#Item Names|item name]]>
: This is the full name of an item. You can use the keyword "all" to set default options for all items.
: This is the full name of an item. You can use the keyword "all" to set default options for all items.


{{Available since 2.1}} Name can be enclosed in quotes for the situation when it contains number at the end.
{{Available since 2.1}} Name can be enclosed in quotes for the situation when it contains number at the end.


; <minimum>
=== <minimum> ===
: This specifies the minimum amount of the item that you want to keep in inventory. This is useful for keeping a certain amount of stackable items in your inventory.  
Minimum amount of the item that you want to keep in inventory. This is useful for keeping a certain amount of stackable items in your inventory.  


'''Note.''' You can't specify an amount other than '''0''' or '''1''' for non-stackable items (like armors). For example, you can't use this to keep 3 Knives in inventory and store or sell the rest.  
=== <auto-store> ===
Store this item when [[storageAuto]] is set.


 
{|class="TablePager"
; <storage>
|-
: This is a flag that controls whether Kore should store the item during auto-storage or not. See the possible flag values below. You must set [[storageAuto]] (and other related options) in [[config.txt]] or this flag has no effect.
{|border="1" cellpadding="2" cellspacing="1"  
|- style=background-color:#F9F9F9;
!Value
!Value
!Description
!Description
|-
|-
|align=center|0
|-
!0
|Do not store this item.
|Do not store this item.
|-
|-
|align=center|1
!1
|Store items from inventory.
|Store items from inventory.
|-
|-
|align=center|2
!2
|Store items from inventory and cart.
|Store items from inventory and cart.
|}
|}


=== <auto-sell> ===
This is a [[References#boolean_flag|boolean]]. Sell this item when [[sellAuto]] is set.


; <sell>
=== [put in cart] ===
: This is a [[References#Basic Value and Parameter Types|boolean flag]] that controls whether Kore should sell the item during auto-sell or not. You must set [[sellAuto]] (and other related options) in [[config.txt]] or this flag has no effect.  
This is a [[References#boolean_flag|boolean]]. Put the item to the cart when the amount of that item in inventory is greater than '''<minimum>'''.


'''Notes:'''
=== [get from car] ===
* If both '''<storage>''' and '''<sell>''' are set to '''1''', Kore will do storage first (unless storage is full) then sell.
This is a [[References#boolean_flag|boolean]]. Get the item from the cart when the amount of that item in inventory is less than '''<minimum>'''.
* Kore will not sell or store equipped items. For example, if you're using a Knife and you have a line to auto-sell all Knives, Kore will sell all Knives except for the one you are currently wielding. This also applies to the cart-transfering options.  


== Notes ==
* Any minimum amount other than '''0''' or '''1''' won't work as expected for non-stackable items (like armors). For example, it can't be used to keep 3 Knives in inventory and store or sell the rest.
* If both storage and sell are enabled, the storage will be done first (unless it's full).
* Equipped items won't be sold or stored. For example, if you're using a Knife and you have a line to auto-sell all Knives, Kore will sell all Knives except for the one you are currently wielding. This also applies to the cart-transfering options.


; <cart add>
== API ==
: This is a [[References#Basic Value and Parameter Types|boolean flag]] that tells if Kore should automatically put the item in your cart when the amount of that item in inventory is greater than '''<minimum>'''. You must have rented a cart or this flag has no effect.
<code>Misc::items_control</code>


 
== Examples ==
; <cart get>
: This is a [[References#Basic Value and Parameter Types|boolean flag]] that tells if Kore should automatically get the item from your cart when the amount of that item in inventory is less than '''<minimum>'''. You must have rented a cart or this flag has no effect.
 
== Example ==
The example below will make Kore do the following:  
The example below will make Kore do the following:  


Line 60: Line 58:
*Put all Flowers in cart.  
*Put all Flowers in cart.  
*Get Red Potions from cart if there is less than 20 Red Potions in your inventory.  
*Get Red Potions from cart if there is less than 20 Red Potions in your inventory.  
*Store all other items.


  Jellopy 0 0 1
  Jellopy 0 0 1
Line 65: Line 64:
  Flower 0 0 0 1 0
  Flower 0 0 0 1 0
  Red Potion 20 0 0 0 1
  Red Potion 20 0 0 0 1
  All 0 1 0
  all 0 1 0
 
== Changelog ==
=== [http://openkore.svn.sourceforge.net/viewvc/openkore?view=revision&revision=8155 r8155] ===
Now [[sellAuto]] will not proceed to sell items marked as unsellable by the server, even if they're configured to be sold.


== See Also ==
* [[buyAuto]]
* [[getAuto]]
* [[storageAuto]]


[[Category:Control]]
[[Category:control]]

Latest revision as of 23:48, 26 April 2021

The file items_control.txt allows you to automatically manage items in your inventory. If you are using storageAuto and/or sellAuto, this gives you control over which items to put in storage and which items to sell. It also has features for automatically transfering items to and from your cart.

All data in this file is case-insensitive.

Syntax

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

<item name> <minimum> <auto-store> <auto-sell> [put in cart] [get from car]

<item name>

This is the full name of an item. You can use the keyword "all" to set default options for all items.
Development.pngThe following documentation describes a feature that was greatly changed in SVN trunk (latest development version) since the last release.
It may work differently or not be available if you're using 2.0.7 or any older version.

Name can be enclosed in quotes for the situation when it contains number at the end.

<minimum>

Minimum amount of the item that you want to keep in inventory. This is useful for keeping a certain amount of stackable items in your inventory.

<auto-store>

Store this item when storageAuto is set.

Value Description
0 Do not store this item.
1 Store items from inventory.
2 Store items from inventory and cart.

<auto-sell>

This is a boolean. Sell this item when sellAuto is set.

[put in cart]

This is a boolean. Put the item to the cart when the amount of that item in inventory is greater than <minimum>.

[get from car]

This is a boolean. Get the item from the cart when the amount of that item in inventory is less than <minimum>.

Notes

  • Any minimum amount other than 0 or 1 won't work as expected for non-stackable items (like armors). For example, it can't be used to keep 3 Knives in inventory and store or sell the rest.
  • If both storage and sell are enabled, the storage will be done first (unless it's full).
  • Equipped items won't be sold or stored. For example, if you're using a Knife and you have a line to auto-sell all Knives, Kore will sell all Knives except for the one you are currently wielding. This also applies to the cart-transfering options.

API

Misc::items_control

Examples

The example below will make Kore do the following:

  • Sell all Jellopies.
  • Store all Knives.
  • Put all Flowers in cart.
  • Get Red Potions from cart if there is less than 20 Red Potions in your inventory.
  • Store all other items.
Jellopy 0 0 1
Knife 0 1 0
Flower 0 0 0 1 0
Red Potion 20 0 0 0 1
all 0 1 0

Changelog

r8155

Now sellAuto will not proceed to sell items marked as unsellable by the server, even if they're configured to be sold.

See Also