items control.txt: Difference between revisions

From OpenKore Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
The file items_control.txt allows you to automatically manage items in your inventory. If you are using [[storageAuto|auto-storage]] and/or [[sellAuto|auto-sell]], 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.


=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> <storage> <sell> <cart add> <cart get>


=Details=
=== Details ===
Detailed view.
----
 
; <[[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.  
 


==<item name> ==
; <minimum>
This is the full name of an item. You can use the keyword "all" to set default options for all items.  
: 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>==
'''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.  
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. Note, however, that for non-stackable items (like armors), you can't specify an amount other than 0 or 1. For example, you can't use this to keep 3 Knives in inventory and store or sell the rest.  


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


{| class="wikitable" border="1" align=center
; <storage>
!Value!!Description
: 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
!Description
|-
|-
|align=center|0||Do not store this item.
|align=center|0
|Do not store this item.
|-
|-
|align=center|1||Store items from inventory.
|align=center|1
|Store items from inventory.
|-
|-
|align=center|2||Store items from inventory and cart.
|align=center|2
|Store items from inventory and cart.
|}
|}


==<sell>==
This is a boolean flag that controls whether Kore should sell the item during auto-sell or not. Set this flag to 1 to enable, or 0 to disable. You must set sellAuto (and other related options) in config.txt or this flag has no effect.


Notes:
; <sell>
If both <storage> and <sell> are set to 1, Kore will do storage first
: 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.  
(unless storage is full) then sell.  


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:'''
* If both '''<storage>''' and '''<sell>''' are set to '''1''', Kore will do storage first (unless storage is full) then sell.
* 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.  


==<cart add>==
This is a 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>. Set this flag to 1 to enable, or 0 to disable. You must have rented a cart or this flag has no effect.


==<cart get>==
; <cart add>
This is a 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>. Set this flag to 1 to enable, or 0 to disable. You must have rented a cart or this flag has no effect.  
: 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.  


==Notes==
Lines that begin with the pound sign (#) are comment lines. They are ignored by Openkore.


=Example=
; <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:  
*Sell all Jellopies.  
*Sell all Jellopies.  
*Store all Knives.  
*Store all Knives.  
Line 52: Line 62:
*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.  


Example:
  Jellopy 0 0 1
  Jellopy 0 0 1
  Knife 0 1 0
  Knife 0 1 0
Line 58: Line 67:
  Red Potion 20 0 0 0 1
  Red Potion 20 0 0 0 1
  All 0 1 0
  All 0 1 0


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

Revision as of 03:34, 14 December 2009

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.


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>

Details


<item name>
This is the full name of an item. You can use the keyword "all" to set default options for all items.


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

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.


<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.
Value Description
0 Do not store this item.
1 Store items from inventory.
2 Store items from inventory and cart.


<sell>
This is a 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.

Notes:

  • If both <storage> and <sell> are set to 1, Kore will do storage first (unless storage is full) then sell.
  • 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.


<cart add>
This is a 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.


<cart get>
This is a 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:

  • 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.
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