Difference between revisions of "avoid.txt"

From OpenKore Wiki
Jump to navigation Jump to search
Line 1: Line 1:
Kore has the ability to avoid certain players. If the option avoidList in config.txt is enabled, you can list players in the file avoid.txt to make Kore automatically avoid certain players.
+
Kore has the ability to avoid certain players. If the option [[avoidList]] in [[config.txt]] is enabled, you can list players in the file avoid.txt to make Kore automatically avoid certain players.
  
Depending on how you set the corresponding options for each player in the list, Kore can either disconnect or teleport when a player in the avoid list is seen. You can also make Kore disconnect when you detect a chat message from a player in the list.The file '''avoid.txt''' has two sections: '''[Players]''' and '''[ID]'''.  
+
Depending on how you set the corresponding options for each player in the list, Kore can either disconnect or teleport when a player in the avoid list is seen. You can also make Kore disconnect when you detect a chat message from a player in the list. The file '''avoid.txt''' has two sections: '''[Players]''' and '''[ID]'''.  
  
==Syntax==
+
== Syntax ==
 
You specify player names that you want to avoid under the section [Players].  
 
You specify player names that you want to avoid under the section [Players].  
 
This section may contain one or more lines that observes the following syntax.
 
This section may contain one or more lines that observes the following syntax.
 +
 
  <player's name> (TAB(s)) <disconnect> <teleport> <disconnect on chat>
 
  <player's name> (TAB(s)) <disconnect> <teleport> <disconnect on chat>
  
  
 
The [ID] section is the same as the [Players] section, but you specify player IDs instead of player names. This is usually used to avoid GMs who have the ability to change their names. The [ID] section may contain one or more lines that observes the following syntax:
 
The [ID] section is the same as the [Players] section, but you specify player IDs instead of player names. This is usually used to avoid GMs who have the ability to change their names. The [ID] section may contain one or more lines that observes the following syntax:
 +
 
  <player's ID> (TAB(s)) <disconnect> <teleport> <disconnect on chat>
 
  <player's ID> (TAB(s)) <disconnect> <teleport> <disconnect on chat>
  
==Details==
 
  
===<player's name>===
+
=== Details ===
This is the name of the player you want to avoid.  
+
----
 +
 
 +
 
 +
; <[[References#Player Names|player's name]]>
 +
: This is the name of the player you want to avoid.
 +
 
 +
 
 +
; <player's ID>
 +
: This is the account ID of the player you want to avoid. You can obtain this value by using the pl console command if the player is nearby.
 +
 
 +
 
 +
; <disconnect>
 +
: This is a [[References#Basic Value and Parameter Types|boolean flag]] that tells if Kore should disconnect when the player is seen on screen. When you disconnect due to avoiding players, Kore will reconnect after the number of seconds specified in the option [[avoidList_reconnect]] in config.txt.
 +
 
 +
 
 +
; <teleport>
 +
: This is a [[References#Basic Value and Parameter Types|boolean flag]] that tells if Kore should teleport away when the player is seen on screen. You must have the Teleport Skill or Fly Wings in inventory or this option will fail (see also [[teleportAuto_useSkill]]).  
  
===<player's ID>===
 
This is the account ID of the player you want to avoid. You can obtain this value by using the pl console command if the player is nearby.
 
  
===<disconnect>===
+
; <disconnect on chat>
This is a boolean flag that tells if Kore should disconnect when the player is seen on screen. Set this flag to 1 to enable, or 0 to disable. When you disconnect due to avoiding players, Kore will reconnect after the number of seconds specified in the option avoidList_reconnect in config.txt.  
+
: This is a [[References#Basic Value and Parameter Types|boolean flag]] that tells if Kore should disconnect when a chat message from the player is detected. When you disconnect due to avoiding players, Kore will reconnect after the number of seconds specified in the option [[avoidList_reconnect]] in config.txt.  
  
===<teleport>===
 
This is a boolean flag that tells if Kore should teleport away when the player is seen on screen. Set this flag to 1 to enable, or 0 to disable. You must have the Teleport Skill or Fly Wings in inventory or this option will fail (see also teleportAuto_useSkill in config.txt).
 
  
===<disconnect on chat>===
+
== Examples ==
This is a boolean flag that tells if Kore should disconnect when a chat message from the player is detected. Set this flag to 1 to enable, or 0 to disable. When you disconnect due to avoiding players, Kore will reconnect after the number of seconds specified in the option avoidList_reconnect in config.txt.
 
  
==Examples==
 
 
If you know the names of the players you want to avoid, you can specify their names under the [Players] section as follows:  
 
If you know the names of the players you want to avoid, you can specify their names under the [Players] section as follows:  
 +
 
  [Players]
 
  [Players]
 
  Grand Master 1 0 0
 
  Grand Master 1 0 0
Line 37: Line 49:
  
 
In the example above, you will disconnect when "Grand Master" is in sight and when "Killer" or "Booya" sends you a chat message. You will also teleport when "Booya" is on sight. On the other hand, if you only know the player ID, place it under the [ID] section as follows:
 
In the example above, you will disconnect when "Grand Master" is in sight and when "Killer" or "Booya" sends you a chat message. You will also teleport when "Booya" is on sight. On the other hand, if you only know the player ID, place it under the [ID] section as follows:
 +
 
  [ID]
 
  [ID]
 
  650874 1 0 1
 
  650874 1 0 1
Line 42: Line 55:
 
The example above will make you disconnect whenever player #650874 is on screen, or when that player sends you a private message.  
 
The example above will make you disconnect whenever player #650874 is on screen, or when that player sends you a private message.  
  
'''''Note'''''. Lines that begin with the pound sign (#) are comment lines. They are ignored by Openkore.
 
  
 
[[Category:Control]]
 
[[Category:Control]]

Revision as of 02:51, 14 December 2009

Kore has the ability to avoid certain players. If the option avoidList in config.txt is enabled, you can list players in the file avoid.txt to make Kore automatically avoid certain players.

Depending on how you set the corresponding options for each player in the list, Kore can either disconnect or teleport when a player in the avoid list is seen. You can also make Kore disconnect when you detect a chat message from a player in the list. The file avoid.txt has two sections: [Players] and [ID].

Syntax

You specify player names that you want to avoid under the section [Players]. This section may contain one or more lines that observes the following syntax.

<player's name> (TAB(s)) <disconnect> <teleport> <disconnect on chat>


The [ID] section is the same as the [Players] section, but you specify player IDs instead of player names. This is usually used to avoid GMs who have the ability to change their names. The [ID] section may contain one or more lines that observes the following syntax:

<player's ID> (TAB(s)) <disconnect> <teleport> <disconnect on chat>


Details



<player's name>
This is the name of the player you want to avoid.


<player's ID>
This is the account ID of the player you want to avoid. You can obtain this value by using the pl console command if the player is nearby.


<disconnect>
This is a boolean flag that tells if Kore should disconnect when the player is seen on screen. When you disconnect due to avoiding players, Kore will reconnect after the number of seconds specified in the option avoidList_reconnect in config.txt.


<teleport>
This is a boolean flag that tells if Kore should teleport away when the player is seen on screen. You must have the Teleport Skill or Fly Wings in inventory or this option will fail (see also teleportAuto_useSkill).


<disconnect on chat>
This is a boolean flag that tells if Kore should disconnect when a chat message from the player is detected. When you disconnect due to avoiding players, Kore will reconnect after the number of seconds specified in the option avoidList_reconnect in config.txt.


Examples

If you know the names of the players you want to avoid, you can specify their names under the [Players] section as follows:

[Players]
Grand Master 1 0 0
Killer 0 0 1
Booya 0 1 1

In the example above, you will disconnect when "Grand Master" is in sight and when "Killer" or "Booya" sends you a chat message. You will also teleport when "Booya" is on sight. On the other hand, if you only know the player ID, place it under the [ID] section as follows:

[ID]
650874 1 0 1

The example above will make you disconnect whenever player #650874 is on screen, or when that player sends you a private message.