View source for Connectivity Guide

==Getting Server Information==
OpenKore comes with a list of official servers information only, because of the high amount of private servers, it is impossible to have and keep them updated, so private servers players should follow this guide to get and update their server information. 
Before continuing, read the list of [[unsupported servers]]. Your server might have anti-bot protection resulting in not being supported by Openkore.

OpenKore requires the following information about the Ragnarok Online server before it can initialize and login:
* The server name
* The server's [[host]] ([[wikipedia:IP address|IP address]] or [[wikipedia:hostname|hostname]]) and [[wikipedia:computer port (software)|port]]
* The server's [[master version]] number, [[version]] number, [[serverEncoding|character encoding]], [[charBlockSize]]
* [[addTableFolders]] to look for tables in

There are detailed instructions on collecting server information with [http://wpepro.net/ WPE] or [http://wireshark.org/ Wireshark]. This kind of packet analyze isn't anything special for OpenKore or Ragnarok Online, so it's up to you to get [[wikipedia:packet analyzer|the tools]] and ways to do it which work for you. It's up to you as well what to do with any so-called "protection" in your server's client that may get in the way.

There may be problems determining [[version]] and [[master_version]] if your server's protocol has some kind of encryption. In that case, merely determining these values won't even help, the main issue is dealing with that encryption.

===WPE (Winsock Packet Editor)===
'''1.''' [http://wpepro.net/index.php?categoryid=4 Download] WPE and extract it. 

:* Before downloading, make a sure to disable your anti-virus as it can mark WPE as a virus and delete it. '''Download at your risk''', we will not be resposabilized if your computer crashes.
:*  You will need some programs to extract it, the common ones are [http://www.rarlab.com/ WinRAR] and [http://www.7-zip.org/ 7zip].

'''2.''' Open your ragnarok but '''''don't login yet!''''' Leave it on the login screen and open WPE.

'''3.''' At WPE's window, click on '''''Target Programs''''' button.
:[[File:Targetyc.png]]

'''4.''' A window will open, search for the server's executable and double-click it.
:[[File:clickrag.png]]

:'''Note.''' Some servers "hide" their executables by renaming it (like from xxxRO.exe to xxxx.dll or xxxxx.bin), so don't worry if the executable isn't a .exe one.

'''5.''' In the WPE's window, click on '''Play button'''.
:[[File:play.png]]

'''6.''' Switch to your Ragnarok's window, put and try to login.
:'''Note.''' Valid login information are not needed.

'''7.''' Back to WPE's window, click on '''Stop button'''
:[[File:stopjw.png]]

'''8.''' A window will open with recorded data. One of the packets sent to the server would be '''login packet''' which usually contains the server's '''version''', '''master_version''', '''IP''' and '''port''' - write them down because they are going to be used later. The packets will be different on each server, possible login packets may start with '''64 00''' or '''02 B0'''. Other packets (such as 18-byte-long '''02 04''') may be sent before login packet.
:[[File:inforb.png]]

:'''Legend''':
#version (displayed as 4-byte unsigned number in [[wikipedia:endianness|little-endian]], in [[wikipedia:hexadecimal|hex]])
#IP (as is)
#port (as is)
#master version (displayed as 1-byte unsigned number, in hex)

'''9.''' See [[Connectivity Guide#Converting Hexadecimal to Decimal numbers|Converting Hexadecimal to Decimal numbers]] to convert the master_version and version before configuring Kore.

===Wireshark===
'''1.''' [http://www.wireshark.org/download.html Download] and install Wireshark.

'''2.''' Open your ragnarok but '''''don't login yet!''''' Leave it on the login screen and open Wireshark.

'''3.''' At Wireshark's window, go to '''Capture > Options''' on the upper menu or press '''Ctrl + K'''.
:[[File:Capiture.png]]

'''4.''' In the top right box, select the interface that will be used to capture on. If there isn't any specific interface to use, select the one whose IP address is equal to the your ip address or is not '''''unknown'''''. Alternatively you can try all of them and use the one that records the packets. Set the others settings like the images bellow:
:[[File:Interface.PNG]]

'''5.''' Click on '''Start button''' and go back to the Ragnarok window and login. 
:'''Note.''' Valid information are not needed.

'''6.''' Back to Wireshark and click on '''Stop button'''.
:[[File:stop.png]]

'''7.''' In Wireshark main window, you can see the TCP segments that were captured. Fill in the packet filter, but what to fill in depends on the username you used to login.
:Enter this in the "Filter" text box: 
 eth contains "xxxxxx" or eth contains xxxxxx

:Replace '''''xxxxxx''''' with the username that was used to login and press enter. In the example bellow, username was Mushroom.
:[[File:filter.png]]

'''8.''' There will be only one entry now, click on it to show some information about it. This is where the '''IP and port''' is stored. 
:[[File:ip.png]]

: Write down the IP and port.

'''9.''' On the entry again, right-click on it and go to '''Follow TCP Stream'''.
:[[File:tcp.png]]

'''10.''' A new window will open, in the bottom left, select '''Hex Dump'''.
:[[File:hex.png]]

'''11.''' These are the login packets. Take a look at it and write down the packets that contains the '''version and master version''' numbers. They are marked on the image bellow.
:[[File:packets.png]]
* version displayed as 4-byte unsigned number in [[wikipedia:endianness|little-endian]], in [[wikipedia:hexadecimal|hex]]
* master version displayed as 1-byte unsigned number, in hex

'''12.''' See [[Connectivity Guide#Converting Hexadecimal to Decimal numbers|Converting Hexadecimal to Decimal numbers]] to convert the master_version and version before configuring Kore.

== Converting Hexadecimal to Decimal numbers ==
Master_version and server version collected from the login packets are in hexadecimal number (base-16) and Kore expects a decimal number (base-10), so converting those numbers are needed before Kore can read them.

Converting can be made using Windows' calculator or any other site that has a hex to dec calculator.

'''1.''' Open Windows calculator '''Start > Accessories > Calculator'''.
:[[File:calc.PNG]]

'''2.''' Go to '''View''' on the upper menu and click on '''Scientific'''.
:[[File:sci.PNG]]

'''3.''' Check the circle beside '''Hex'''.
:[[File:hexa.PNG]]

'''4.''' On the calculator, type the number that you got for master_version and version. In the example, master_version hexadecimal number is '''10'''.
:[[File:type.PNG]]

'''5.''' Check the circle beside '''Dec'''.
:[[File:dec.PNG]]

'''6.''' After checking, the number shown should automatically be converted from hexadecimal to decimal.
:[[File:done.PNG]]

: You must convert '''master_version''' and '''version'''.

== Configuring Openkore ==
OpenKore reads server information from a file named '''servers.txt'''. The file is on ''tables'' folder.

If your server is not listed in the file, then add a new entry. If your server is already listed, then modify the existing entry. 

=== Syntax ===
<pre>[<server name>]
ip <number/host>
port <number>
version <number>
master_version <number> 
serverType <serverType name>
serverEncoding <enconding>
charBlockSize <number>
addTableFolders <folder path>

#Following configs are optional
captcha <boolean flag>
chatLangCode <boolean flag>
field_<location> <filename>
clientHash <hex string>
gameGuard <number>
private <boolean flag> 
paddedPackets <boolean flag>
paddedPackets_attackID <packet switches>
paddedPackets_skillUseID <packet switches>
secureLogin <boolean flag>
secureLogin_type <type>
secureLogin_requestCode <hex string>
secureLogin_account <boolean flag>
storageEncryptKey <encrypt key>
recvpackets <file name>
masterLogin_packet <packet switch></pre>

==== Required ====

; [<server name>]
: The name of the server that you want to bot. The name '''must be''' between '''[ ]'''.

; ip <number/host>
: Server's login IP.

; port <number>
: Server's login port number.

; version <number>
: Server's version (converted from hex to decimal).

; master_version <number>
: Server's master_version (converted from hex to decimal).

; [[serverType]]
{{Available since 2.1}}
: Server's type. Each official server has its own serverType, private servers must use '''kRO serverTypes''' according to executables dates.

; serverEncoding
: Characters encoding type. The character encoding cannot be automatically detected, but here's a list of possible character encodings that you can use: 

:{| class="wikitable" border="1" cellspacing="1"
!Encoding
!Language used 
|-
|align=center|Western 
| Language which uses a Roman-based alphabet. Example: English, German, French, Portuguese, Indonesian, etc. 
|-
|align=center|Simplified Chinese 
|  Simplified Chinese. 
|-
|align=center|Traditional Chinese
|  Traditional Chinese. 
|-
|align=center|Korean
|  Korean
|-
|align=center|Russian
|  Russian, or a Cyrillic-based language. 
|-
|align=center|Japanese
|  Japanese
|-
|align=center|Thai 
|  Thai
|}

{{:charBlockSize}}

; addTableFolders <folder path>
: Configures Kore to load tables file from the specified path (relative to the tables directory).
: Used only when there is no [[Command Line Arguments|--tables]] specified.
: For english ones, you can use
 addTableFolders translated/kRO_english
: or 
 addTableFolders iRO

==== Optional ====

; captcha <boolean flag>
: Configure Kore to use the captcha 'protocol'.

{{:chatLangCode}}
<!--
; field_<location> <filename>
: Use morocc_old.fld instead morocc.fld: <pre>field_morocc morocc_old</pre>

; clientHash <hex string>
: ??
-->

; gameGuard <number>
: Used for GameGuard and HackShield. See also: [[Poseidon]].

; private <boolean flag> 
: Set this option if Openkore connects to a wrong map-server IP. Usually for private servers.
<!-- 
; paddedPackets <boolean flag>
: ??

; paddedPackets_attackID <packet switches>
: ??
 
; paddedPackets_skillUseID <packet switches>
: ??

; secureLogin <boolean flag>
: ??

; secureLogin_type <type>
: ??

; secureLogin_requestCode <hex string>
: ??

; secureLogin_account <boolean flag>
: ??
 -->

; recvpackets <file name.txt>
: Configures file's name for recvpackets. See also: [[Packet Length Extractor]].

; masterLogin_packet <packet switch>
: Overrides master login packet switch (but not its structure). Required for [[XKore]] 2 if it's different from 0064.

=== Example ===
 [MushroomRO]
 ip 127.0.0.1
 port 6900
 master_version 16
 version 20
 serverType kRO_RagexeRE_2010_01_26a
 charBlockSize 108
 serverEncoding Western
 recvpackets mush-recvpackets.txt
 addTableFolders iRO

[[Category:servers.txt]]