Difference between revisions of "manual"

From OpenKore Wiki
Jump to navigation Jump to search
(39 intermediate revisions by 8 users not shown)
Line 1: Line 1:
The manual describes all of the configuration options and commands for the latest Openkore release and Openkore SVN version.
+
The manual describes all of the configuration options and commands for the latest Openkore release and Openkore Git version.
  
=Introduction to OpenKore=
+
==Introduction to OpenKore==
  
OpenKore is a [http://www.gnu.org/philosophy/free-sw.html/ free], [http://www.opensource.org/docs/definition.php/ Open Source] custom client for Ragnarok Online servers. It is written in [http://www.perl.org/ Perl], and is cross-platform. The officially platforms are Win32 and Linux. The codebase is derived from '''Solos Kore'''.
+
OpenKore is a [http://www.gnu.org/philosophy/free-sw.html free], [http://www.opensource.org/docs/definition.php Open Source] custom client for Ragnarok Online servers. It is written in [http://www.perl.org Perl], and is cross-platform. The officially platforms are Win32 and Linux. The codebase is derived from '''Solos Kore'''.
  
 
This project provides development resources and encourages all developers who work on (their own version of) Kore to unite. New developers are welcome. Feel free to participate.
 
This project provides development resources and encourages all developers who work on (their own version of) Kore to unite. New developers are welcome. Feel free to participate.
Line 9: Line 9:
 
'''Note.''' Gravity (the company that developed Ragnarok Online) has nothing to do with OpenKore. This project is unofficial.
 
'''Note.''' Gravity (the company that developed Ragnarok Online) has nothing to do with OpenKore. This project is unofficial.
  
The original Kore written by Kura is licenced under [http://www.gnu.org/licenses/gpl.html/ GNU General Public License (GPL)], therefore anyone who publish a mod of Kore must also publish it's source code. Also anyone who uses this mod has the right to publish copies of the program and the source.
+
The original Kore written by Kura is licenced under [http://www.gnu.org/licenses/gpl.html GNU General Public License (GPL)], therefore anyone who publishes a mod of Kore must also publish it's source code. Also anyone who uses this mod has the right to publish copies of the program and the source.
  
=First time user =
+
[[Openkore|Read more about history and current status of OpenKore]].
  
Please read the [http://wiki.openkore.com/index.php?title=Quick_Start_Guide Quick Start Guide] to help you easily install and setup Openkore.
+
==First time user==
  
The [http://wiki.openkore.com/index.php?title=References References] section will be a great help when configuring your bot.
+
Please read the [[Quick Start Guide]] to help you easily install and setup Openkore.
  
After learning about how to configure Openkore, the [http://hakore.bot.nu/?p=openkore+config+checker Config Check utility] can help you validate your own created [http://wiki.openkore.com/index.php?title=Config.txt config.txt] file.
+
The [[References]] section will be a great help when configuring your bot.
  
=Configuration Files =
+
After learning about how to configure Openkore, the [http://hakore.bot.nu/?p=openkore+config+checker Config Check utility] can help you validate your own created [[:Category:config.txt|config.txt]] file.
  
<ul>
+
==Configuration Files==
  <li>[http://wiki.openkore.com/index.php?title=Arrowcraft.txt arrowcraft.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Avoid.txt avoid.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Chat_resp.txt chat_resp.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Config.txt config.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Consolecolors.txt consolecolors.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Items_control.txt items_control.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Mon_control.txt mon_control.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=OverallAuth.txt overallAuth.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Pickupitems.txt pickupitems.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Priority.txt priority.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Responses.txt responses.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Routeweights.txt routeweights.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Shop.txt shop.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Sys.txt sys.txt]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Timeouts.txt timeouts.txt]</li>
 
</ul>
 
  
=Commands=
+
*[[arrowcraft.txt]]
 +
*[[avoid.txt]]
 +
*[[chat_resp.txt]]
 +
*[[:Category:config.txt|config.txt]]
 +
*[[consolecolors.txt]]
 +
*[[items_control.txt]]
 +
*[[macro_plugin|macros.txt ''(only with macro plugin)'']]
 +
*[[mon_control.txt]]
 +
*[[overallAuth.txt]]
 +
*[[pickupitems.txt]]
 +
*[[priority.txt]]
 +
*[[responses.txt]]
 +
*[[routeweights.txt]]
 +
*[[shop.txt]]
 +
*[[sys.txt]]
 +
*[[timeouts.txt]]
  
<ul>
+
==Commands==
  <li>[http://wiki.openkore.com/index.php?title=Console_Commands Console Commands]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=Chat_Commands Chat Commands ]</li>
 
</ul>
 
  
=References=
+
*[[:Category:Console Command|Console Commands]]
 +
*[[Chat Commands]]
  
<ol>
+
==FAQ==
  <li>[http://wiki.openkore.com/index.php?title=References#Syntax_Legends Syntax Legends]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=References#Basic_Value_and_Parameter_Types Basic Value and Parameter Types]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=References#Equipment_Slots Equipment Slots]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=References#Message_Domains Message Domains]</li>
 
  <li>Names (Text)</li>
 
  <ul>
 
    <li>[http://wiki.openkore.com/index.php?title=References#Equipment_Names Equipment]</li>
 
    <li>[http://wiki.openkore.com/index.php?title=References#Item_Names Item]</li>
 
    <li>[http://wiki.openkore.com/index.php?title=References#Ground_Spell_Names Ground Spell]</li>
 
    <li>[http://wiki.openkore.com/index.php?title=References#Map_Names Map]</li>
 
    <li>[http://wiki.openkore.com/index.php?title=References#Monster_Names Monster]</li>
 
    <li>[http://wiki.openkore.com/index.php?title=References#Player_Names Player]</li>
 
    <li>[http://wiki.openkore.com/index.php?title=References#Skill_Names Skill]</li>
 
    <li>[http://wiki.openkore.com/index.php?title=References#Status_Names Status]</li>
 
  </ul>
 
  <li>[http://wiki.openkore.com/index.php?title=References#NPC_Conversation_Codes NPC Conversation Codes]</li>
 
  <li>[http://wiki.openkore.com/index.php?title=References#Range_Operators Range Operators]</li>
 
</ol>
 
  
=FAQ=
+
If you need help, this is the first place where you can get most information. [[Frequently Asked Questions]] provides you most frequent questions with intensive answers. You can also visit the [http://forums.openkore.com/ Openkore Forum] where you can discuss and share experience with other members.
  
If you need help, this is the first place where you can get most information. [http://wiki.openkore.com/index.php?title=Frequently_Asked_Questions FAQ] provides you most frequent questions with intensive answers. You can also visit the [http://forums.openkore.com/ Openkore Forum] where you can discuss and share experience with other members.
+
==Links==
  
=Links=
+
* [[Connectivity Guide]]
 
+
* [[poseidon|Poseidon Guide]]
<ul>
+
* [[serverType]]
  <li>[http://wiki.openkore.com/index.php?title=Connectivity_Guide&action=edit&redlink=1 Connectivity Guide]</li>
+
* [[XKore|XKore Guide]]
  <li>[http://wiki.openkore.com/index.php?title=ServerType&action=edit&redlink=1 Server Type]</li>
+
* [[FLD Creation Guide]]
  <li>[http://wiki.openkore.com/index.php?title=XKore_Guide&action=edit&redlink=1 XKore Guide]</li>
+
* [[Packet Length Extractor]]
  <li>[http://wiki.openkore.com/index.php?title=Packet_Length_Extractor&action=edit&redlink=1 Packet Length Extractor]</li>
+
* [[:Category:Interfaces|Interfaces]]: [[Console_Interface|Console]] | [[Wx_Interface|Wx]] | [[Socket_Interface|Socket]] | [[Curses_Interface|Curses]]
</ul>
+
* [[Git|Git Guide]]
 +
* Guide "[[How_to_write_plugins_for_OpenKore|How to write plugins for OpenKore]]"
 +
* [[How to run OpenKore]]
 +
* [[:Category:Plugins|How to use plugins]]

Revision as of 19:36, 27 April 2021

The manual describes all of the configuration options and commands for the latest Openkore release and Openkore Git version.

Introduction to OpenKore

OpenKore is a free, Open Source custom client for Ragnarok Online servers. It is written in Perl, and is cross-platform. The officially platforms are Win32 and Linux. The codebase is derived from Solos Kore.

This project provides development resources and encourages all developers who work on (their own version of) Kore to unite. New developers are welcome. Feel free to participate.

Note. Gravity (the company that developed Ragnarok Online) has nothing to do with OpenKore. This project is unofficial.

The original Kore written by Kura is licenced under GNU General Public License (GPL), therefore anyone who publishes a mod of Kore must also publish it's source code. Also anyone who uses this mod has the right to publish copies of the program and the source.

Read more about history and current status of OpenKore.

First time user

Please read the Quick Start Guide to help you easily install and setup Openkore.

The References section will be a great help when configuring your bot.

After learning about how to configure Openkore, the Config Check utility can help you validate your own created config.txt file.

Configuration Files

Commands

FAQ

If you need help, this is the first place where you can get most information. Frequently Asked Questions provides you most frequent questions with intensive answers. You can also visit the Openkore Forum where you can discuss and share experience with other members.

Links