diff options
| -rw-r--r-- | README.txt | 177 | ||||
| -rw-r--r-- | readme.html | 43 | ||||
| -rw-r--r-- | readme/commands.html | 34 | ||||
| -rw-r--r-- | readme/faq.html | 66 | ||||
| -rw-r--r-- | readme/images/bg.gif | bin | 3121 -> 0 bytes | |||
| -rw-r--r-- | readme/images/clown.png | bin | 590954 -> 0 bytes | |||
| -rw-r--r-- | readme/resources.html | 60 | ||||
| -rw-r--r-- | readme/scripting.html | 65 | ||||
| -rw-r--r-- | readme/setup.html | 64 | ||||
| -rw-r--r-- | readme/style.css | 83 |
10 files changed, 177 insertions, 415 deletions
diff --git a/README.txt b/README.txt new file mode 100644 index 000000000..485ea5857 --- /dev/null +++ b/README.txt @@ -0,0 +1,177 @@ +//============================================================ +//= rAthena ReadMe File +//===== By: ================================================== +//= rAthena Development Team +//===== Compatible With: ===================================== +//= rAthena SVN +//===== Description: ========================================= +//= Basic information and installation guide with links to +//= various forum posts and wiki articles. +//============================================================ + +============================ +|| Table of Contents || +============================ +|| 1. What is rAthena? || +|| 2. Prerequisits || +|| 3. Installation || +|| 4. Troubleshooting || +|| 5. Helpful Links || +|| 6. More Documentation || +============================ + + +============================ +|| 1. What is rAthena? || +============================ + rAthena is a collaborative software development project revolving around the +creation of a robust massively multiplayer online role playing game (MMORPG) +server package. Written in C, the program is very versatile and provides NPCs, +warps and modifications. The project is jointly managed by a group of volunteers +located around the world as well as a tremendous community providing QA and +support. rAthena is a continuation of the eAthena project. + + + +============================ +|| 2. Prerequisists || +============================ + Before installing rAthena there are certain tools and applications you will need. +This differs between the varying operating systems available, so the following +is broken down into Windows and linux prerequisists. + + Windows + * TortoiseSVN (http://tortoisesvn.net/downloads.html) + * MySQL (http://www.mysql.com/downloads/mysql/) + * MySQL Workbench (http://www.mysql.com/downloads/workbench/) + * MS Visual C++ (http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express) + + Linux (names of packages may require specific version numbers on certain distributions) + * gcc + * make + * mysql + * mysql-devel + * mysql-server + * pcre-devel + * subversion + * zlib-devel + + + +============================ +|| 3. Installation || +============================ + This section is a very brief set of installation instructions. For more concise guides +relevant to your Operation System, please refer to the Wiki (links at the end of this file). + +Windows + * Install prerequisites + * Create a folder to download rAthena into (e.g. C:\rAthena) + * Right click this folder and select "SVN Checkout". + * Paste the SVN URL into the box: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ + * Open MySQL Workbench and create an instance to connect to your MySQL Server + * Create a database (rathena), a user (rathena), give permissions (GRANT SELECT,INSERT,UPDATE,DELETE) + and then login using the new user + * Use MySQL Workbench to run the .sql files in /sql-files/ on the new rathena database + +Linux + (For CentOS) Type: yum install gcc make mysql mysql-devel mysql-server pcre-devel subversion zlib-devel + (For Debian) Type: apt-get install subversion make gcc libmysqlclient-dev zlib1g-dev libpcre3-dev + * Type: mysql_secure_installation + * Start your MySQL server + * Setup a MySQL user: CREATE USER 'rathena'@'localhost' IDENTIFIED BY 'password'; + * Assign permissions: GRANT SELECT,INSERT,UPDATE,DELETE ON `rathena\_rag`.* TO 'rathena'@'localhost'; + * Type: svn checkout https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ ~/trunk + * Insert SQL files: mysql --user=root -p rathena_rag < trunk/sql-files/main.sql (and others) + * Type: cd trunk && ./configure && make clean && make sql + * When you're ready, type: ./athena-start start + + + +============================ +|| 4. Troubleshooting || +============================ + If you're having problems with starting your server, the first thing you should +do is check what's happening on your consoles. More often that not, all support issues +can be solved simply by looking at the error messages given. + +Examples: + + 1.) You get an error on your map-server_sql that looks something like this: + [Error]: npc_parsesrcfile: Unable to parse, probably a missing or extra TAB in + file 'npc/custom/jobmaster.txt', line '17'. Skipping line... + * w1=prontera,153,193,6 script + * w2=Job Master + * w3=123,{ + * w4= + + If you look at the error, it's telling you that you're missing (or have an extra) TAB. + This is easily fixed by looking at this part of the error: * w1=prontera,153,193,6 script + If there was a TAB where it's supposed to be, that line would have prontera,153,193,6 at w1 + and 'script' at w2. As there's a space instead of a TAB, the two sections are read as a + single parameter. + + 2.) You have a default user/password warning similar to the following: + [Warning]: Using the default user/password s1/p1 is NOT RECOMMENDED. + [Notice]: Please edit your 'login' table to create a proper inter-server user/pa + ssword (gender 'S') + [Notice]: and then edit your user/password in conf/map_athena.conf (or conf/impo + rt/map_conf.txt) + + Relax. This is just indicating that you're using the default username and password. To + fix this, check over the part in the installation instructions relevant to the `login` table. + + 3.) Your Map Server says the following: + [Error]: make_connection: connect failed (socket #2, error 10061: No connection + could be made because the target machine actively refused it. + )! + + If this shows up on the map server, it generally means that there is no Char Server available + to accept the connection. + + + +============================ +|| 5. Helpful Links || +============================ + The following list of links point to various helpfiles within the SVN, articles or +pages on the wiki or topics within the rAthena forum. + + * rAthena Forums + http://rathena.org/ + + * SVN Repository URL: + https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ + + * Full Installation Instructions: + Windows http://rathena.org/wiki/Installation_on_Windows + CentOS http://rathena.org/wiki/Installation_(CentOS) + Debian http://rathena.org/wiki/Installation_(Debian) + + * rAthena IRC Channel + irc://irc.rathena.net + + + +============================ +|| 6. More Documentation || +============================ + rAthena has a large collection of help files and sample NPC scripts located in /doc/ + + * Scripting + It is recommended to look through /doc/script_commands.txt for help, pointers or + even for ideas for your next NPC script. Most script commands have a usage example. + + * @commands + In-game, Game Masters have the ability to use Atcommands (@) to control players, + create items, spawn mobs, reload configuration files and even control the weather. + For an in-depth explaination, please see /doc/atcommands.txt + + * Permissions + The rAthena emulator has a permission system that enables certain groups of players + to perform certain actions, or have access to certain visual enhancements or in-game + activity. To see what permissions are available, they are detailed in /doc/permissions.txt + +There are more files in the /doc/ directory that will help you to create scripts or update the +mapcache, er even explain how the job system and item bonuses work. Before posting a topic asking +for help on the forums, we reccomend that all users take the time to look over this directory.
\ No newline at end of file diff --git a/readme.html b/readme.html deleted file mode 100644 index 82c51913d..000000000 --- a/readme.html +++ /dev/null @@ -1,43 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> - <head> - <title>rAthena | Intro</title> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> - <link rel="stylesheet" type="text/css" href="./readme/style.css"> - </head> - <body> - <div id="template"> - <div id="header"> - <div class="logo">rAthena<br><span class="subtitle">- RAGNAROK Online Server Emulator</span></div> - <div class="title">Intro</div> - </div> - <div id="navcontainer"> - <ul id="navlist"> - <li><a href="./readme.html">Intro</a></li> - <li><a href="./readme/setup.html">Setup</a></li> - <li><a href="./readme/faq.html">FAQ</a></li> - <li><a href="./readme/scripting.html">Scripting</a></li> - <li><a href="./readme/commands.html">GM Commands</a></li> - <li><a href="./readme/resources.html">Resources</a></li> - </ul> - </div> - - <div class="body-container"> - <ul> - <li><span class="body-title">What is rAthena?</span><br> - rAthena is a collaborative software development project revolving around the creation of a robust massively multiplayer online role playing game (MMORPG) server package. Written in C, the program is very versatile and provides NPCs, warps and modifications. The project is jointly managed by a group of volunteers located around the world as well as a tremendous community providing QA and support. rAthena is a continuation of the eAthena project. - </li> - </ul> - - <ul> - <li><span class="body-title">Who are the rAthena developers?</span><br> - You can find a list of the currently active rAthena developers at:<br> - <a href="http://sourceforge.net/project/memberlist.php?group_id=637719" target="_new">http://sourceforge.net/project/memberlist.php?group_id=637719</a> - </li> - </ul> - </div> - - <div id="footer">"Read Me" Created & Designed by <a href="http://www.kisuka.com" target="_new">Kisuka</a></div> - </div> - </body> -</html> diff --git a/readme/commands.html b/readme/commands.html deleted file mode 100644 index 2e35079e0..000000000 --- a/readme/commands.html +++ /dev/null @@ -1,34 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> - <head> - <title>rAthena | GM Commands</title> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> - <link rel="stylesheet" type="text/css" href="style.css"> - </head> - <body> - <div id="template"> - <div id="header"> - <div class="logo">rAthena<br><span class="subtitle">- RAGNAROK Online Server Emulator</span></div> - <div class="title">GM Commands</div> - </div> - <div id="navcontainer"> - <ul id="navlist"> - <li><a href="../readme.html">Intro</a></li> - <li><a href="setup.html">Setup</a></li> - <li><a href="faq.html">FAQ</a></li> - <li><a href="scripting.html">Scripting</a></li> - <li><a href="commands.html">GM Commands</a></li> - <li><a href="resources.html">Resources</a></li> - </ul> - </div> - - <div class="body-container"> - The following are the GM Commands which can be used in-game on an rAthena server.<br><br> - <iframe width="100%" height="35%" src="../doc/atcommands.txt"></iframe><br><br> - <iframe width="100%" height="35%" src="../conf/charhelp.txt"></iframe> - </div> - - <div id="footer">"Read Me" Created & Designed by <a href="http://www.kisuka.com" target="_new">Kisuka</a></div> - </div> - </body> -</html> diff --git a/readme/faq.html b/readme/faq.html deleted file mode 100644 index 50cb0f189..000000000 --- a/readme/faq.html +++ /dev/null @@ -1,66 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> - <head> - <title>rAthena | FAQ</title> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> - <link rel="stylesheet" type="text/css" href="style.css"> - </head> - <body> - <div id="template"> - <div id="header"> - <div class="logo">rAthena<br><span class="subtitle">- RAGNAROK Online Server Emulator</span></div> - <div class="title">FAQ</div> - </div> - <div id="navcontainer"> - <ul id="navlist"> - <li><a href="../readme.html">Intro</a></li> - <li><a href="setup.html">Setup</a></li> - <li><a href="faq.html">FAQ</a></li> - <li><a href="scripting.html">Scripting</a></li> - <li><a href="commands.html">GM Commands</a></li> - <li><a href="resources.html">Resources</a></li> - </ul> - </div> - - <div class="body-container"> - The following are frequently asked questions regarding rAthena.<br><br> - <dl> - <dt>Where can I set the exp rates?</dt> - <dd> - <ul> - <li>Go to /conf/battle/exp.conf</li> - <li>Find base_exp_rate and job_exp_rate. Change the value there to raise or lower the rates.</li> - <li>100 = 1x, 1000 = 10x rates, etc</li> - </ul> - </dd> - - <dt>Where can I set the item drop rates?</dt> - <dd> - <ul> - <li>Go to /conf/battle/drops.conf</li> - <li>You can set the drop rates by changing the values:<br> - <code> - item_rate_common: 100 <-- 100 = 1x drop rate, 1000 = 10x drop rate, etc<br> - item_rate_common_boss: 100 <--- drop rate for bosses<br> - item_drop_common_min: 1 <--- minimal drop rate<br> - item_drop_common_max: 10000 <--- maximum drop rate. - </code><br> - (You can set the rates of different items in the same file) - </ul> - </dd> - - <dt>I found a bug, where to I report it?</dt> - <dd>If you find a bug in rAthena, report it here: <a href="http://rathena.org/board/tracker/" target="_blank">Bug Tracker</a></dd> - - <dt>I'm a well-experienced programmer, can I join the rAthena dev team?</dt> - <dd>You can apply in the <a href="http://rathena.org/board/index.php?app=contactus" target="_blank">Developer Applications</a> topic.</dd> - - <dt>My character won't move, and no windows open when I login to the game, what's wrong?</dt> - <dd>Your packet_db_ver is most likely set wrong, change it in /db/packet_db.txt to match your client's packet ver.</dd> - </dl> - </div> - - <div id="footer">"Read Me" Created & Designed by <a href="http://www.kisuka.com" target="_new">Kisuka</a></div> - </div> - </body> -</html> diff --git a/readme/images/bg.gif b/readme/images/bg.gif Binary files differdeleted file mode 100644 index 6c8c92c3b..000000000 --- a/readme/images/bg.gif +++ /dev/null diff --git a/readme/images/clown.png b/readme/images/clown.png Binary files differdeleted file mode 100644 index 55de4ba60..000000000 --- a/readme/images/clown.png +++ /dev/null diff --git a/readme/resources.html b/readme/resources.html deleted file mode 100644 index 9b8566e28..000000000 --- a/readme/resources.html +++ /dev/null @@ -1,60 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> - <head> - <title>rAthena | Resources</title> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> - <link rel="stylesheet" type="text/css" href="style.css"> - </head> - <body> - <div id="template"> - <div id="header"> - <div class="logo">rAthena<br><span class="subtitle">- RAGNAROK Online Server Emulator</span></div> - <div class="title">Resources</div> - </div> - <div id="navcontainer"> - <ul id="navlist"> - <li><a href="../readme.html">Intro</a></li> - <li><a href="setup.html">Setup</a></li> - <li><a href="faq.html">FAQ</a></li> - <li><a href="scripting.html">Scripting</a></li> - <li><a href="commands.html">GM Commands</a></li> - <li><a href="resources.html">Resources</a></li> - </ul> - </div> - - <div class="body-container"> - The following are some links to various resources which can be helpful when using rAthena.<br> - <ul> - <li><a href="http://rathena.org/" target="_new">http://rathena.org/</a><br> - The official rAthena project website.</li> - - <li><a href="https://rathena.svn.sourceforge.net/svnroot/rathena/" target="_new">https://rathena.svn.sourceforge.net/svnroot/rathena/</a><br> - The official SVN of the rAthena project.</li> - - <li><a href="irc://irc.rathena.net" target="_new">irc://irc.rathena.net</a><br> - The official rAthena IRC Channel.</li> - - <li><a href="http://forum.asb-sakray.net/" target="_new">http://forum.asb-sakray.net/</a><br> - The official AEGIS Support Board.</li> - - <li><a href="http://www.ragnarokonline.com/" target="_new">http://www.ragnarokonline.com/</a><br> - The official Ragnarok Online website.</li> - - <li><a href="http://nn.nachtwolke.com/dev/npclist/" target="_new">http://nn.nachtwolke.com/dev/npclist/</a><br> - List of Ragnarok Online NPC sprite names and IDs.</li> - - <li><a href="../doc/script_commands.txt" target="_new">Script Commands</a><br> - Documentation of the script commands available in rAthena.</li> - - <li><a href="../doc/effect_list.txt" target="_new">Effect List</a><br> - Documentation of the visual effects available in rAthena.</li> - - <li><a href="../doc/item_bonus.txt" target="_new">Item Bonuses</a><br> - Documentation of the item bonuses available in rAthena.</li> - </ul> - </div> - - <div id="footer">"Read Me" Created & Designed by <a href="http://www.kisuka.com" target="_new">Kisuka</a></div> - </div> - </body> -</html> diff --git a/readme/scripting.html b/readme/scripting.html deleted file mode 100644 index 0218464b3..000000000 --- a/readme/scripting.html +++ /dev/null @@ -1,65 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> - <head> - <title>rAthena | Scripting</title> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> - <link rel="stylesheet" type="text/css" href="style.css"> - </head> - <body> - <div id="template"> - <div id="header"> - <div class="logo">rAthena<br><span class="subtitle">- RAGNAROK Online Server Emulator</span></div> - <div class="title">Scripting</div> - </div> - <div id="navcontainer"> - <ul id="navlist"> - <li><a href="../readme.html">Intro</a></li> - <li><a href="setup.html">Setup</a></li> - <li><a href="faq.html">FAQ</a></li> - <li><a href="scripting.html">Scripting</a></li> - <li><a href="commands.html">GM Commands</a></li> - <li><a href="resources.html">Resources</a></li> - </ul> - </div> - - <div class="body-container"> - How to create an NPC using rAthena's scripting:<br><br> - <code><font color="#0000FF">map_name</font>,<font color="#009900">x_cord</font>,<font color="#0CF305">y_cord</font>,<font color="#FF0000">npc_facing_direction</font> <strong>-TAB-</strong> script <strong>-TAB-</strong> <font color="#FF6600">NPC Name</font>#<font color="#FFCC00">HiddenName</font> <strong>-TAB-</strong> <font color="#CC3399">Sprite ID</font>,{<br> - mes "[NPC Name]";<br> - mes "Hello World";<br> - close;<br> - }</code><br><br> - - <strong>Common Script Commands:</strong> - <ul> - <li><strong>mes "<message>";</strong><br> - displays a line of text in an NPC's dialog window.</li> - <li><strong>close;</strong><br> - displays a "Close" button in an NPC's dialog window. - </li> - <li><strong>next;</strong><br> - displays a "Next" button in an NPC's dialog window. - </li> - <li><strong>getitem <item id>,<amount>;</strong><br> - gives the player an item. - </li> - <li><strong>delitem <item id>,<amount>;</strong><br> - deletes an item from the player. - </li> - </ul> - <strong>Script Command Documentation:</strong><br> - All the script commands in rAthena can be found <a href="../doc/script_commands.txt" target="_new">here</a>.<br><br> - <strong>How to enable your NPC:</strong> - <ol> - <li>Save it as a text file in your /npc/custom/ folder.</li> - <li>Open /npc/scripts_custom.conf</li> - <li>Add the following line:<br> - <code>npc: npc/custom/name_of_your_text_file.txt</code></li> - <li>Save and close.</li> - </ol> - </div> - - <div id="footer">"Read Me" Created & Designed by <a href="http://www.kisuka.com" target="_new">Kisuka</a></div> - </div> - </body> -</html> diff --git a/readme/setup.html b/readme/setup.html deleted file mode 100644 index 8005d4a89..000000000 --- a/readme/setup.html +++ /dev/null @@ -1,64 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> - <head> - <title>rAthena | Setup</title> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> - <link rel="stylesheet" type="text/css" href="style.css"> - </head> - <body> - <div id="template"> - <div id="header"> - <div class="logo">rAthena<br><span class="subtitle">- RAGNAROK Online Server Emulator</span></div> - <div class="title">Setup</div> - </div> - <div id="navcontainer"> - <ul id="navlist"> - <li><a href="../readme.html">Intro</a></li> - <li><a href="setup.html">Setup</a></li> - <li><a href="faq.html">FAQ</a></li> - <li><a href="scripting.html">Scripting</a></li> - <li><a href="commands.html">GM Commands</a></li> - <li><a href="resources.html">Resources</a></li> - </ul> - </div> - - <div class="body-container"> - <strong>Character Server:</strong> - <ol> - <li>Open /conf/char_athena.conf</li> - <li>Change userid and passwd (s1/p1) to what you want your server's communication details to be.</li> - <li>Change Server_Name to what you want to call your server.</li> - <li>Remove the <strong>//</strong> before login_ip. - <li>Remove the <strong>//</strong> before char_ip and change 127.0.0.1 to your <a href="http://www.whatismyip.com" target="_new">WAN IP</a>. - </ol> - - <strong>Map Server:</strong> - <ol> - <li>Open /conf/map_athena.conf</li> - <li>Change userid and passwd to the same thing you set in char_athena.</li> - <li>Remove the <strong>//</strong> before char_ip.</li> - <li>Remove the <strong>//</strong> before map_ip and change 127.0.0.1 to your <a href="http://www.whatismyip.com" target="_new">WAN IP</a>. - </ol> - - <strong>Subnet:</strong> - <ol> - <li>Open /conf/subnet_athena.conf</li> - <li>Change 255.0.0.0 to your <strong>"Subnet Mask"</strong>, change the two 127.0.0.1 to your <strong>LAN IP</strong>. - </ol> - - <strong>MySQL Settings:</strong> - <ol> - <li>Open /conf/inter_athena.conf</li> - <li>Find the "Global SQL Settings" and change them to your SQL server's settings.</li> - </ol> - - <strong>Message of the Day:</strong> - <ol> - <li>Open /conf/motd.txt and edit it to change the in-game MOTD.</li> - </ol> - </div> - - <div id="footer">"Read Me" Created & Designed by <a href="http://www.kisuka.com" target="_new">Kisuka</a></div> - </div> - </body> -</html> diff --git a/readme/style.css b/readme/style.css deleted file mode 100644 index 9b49a32b0..000000000 --- a/readme/style.css +++ /dev/null @@ -1,83 +0,0 @@ -/* Created by Kisuka */ -/* www.kisuka.com */ -html, body { - height: 100%; - margin: 0; - background-image:url(images/bg.gif); -} -body { - width: 900px; - height: 100%; - border-left:thin solid #000; - border-right:thin solid #000; - margin-left:auto; - margin-right:auto; - background:#FFF url(images/clown.png) no-repeat fixed right bottom; -} -#template { position:relative; min-height:100%; } -* html #template { height: 100%; } -#header { - height: 60px; - border-bottom:thin solid #000; -} -.logo { - float:left; - padding-left:25px; - font-size:x-large; -} -.title { - float:right; - padding-right:25px; - font-size:xx-large; - padding-top:10px; -} -.body-title { - font-size:x-large; -} -.subtitle { - font-size:14px; - padding-left:10px; - font-style:italic; -} -.body-container { - padding-left:30px; - padding-right:30px; -} -#navcontainer ul { -padding-left: 0; -margin-left: 0; -margin-top:0; -background-color: #000; -color: White; -float: left; -width: 100%; -font-family: arial, helvetica, sans-serif; -} -#navcontainer ul li { display: inline; } -#navcontainer ul li a { - padding: 0.2em 1em; - background-color: #000; - color: White; - text-decoration: none; - float: left; - border-right: 1px solid #fff; -} -#navcontainer ul li a:hover { - background-color: #666; - color: #fff; -} -#footer { - background-color: #000; - width: 100%; - color: White; - position:absolute; - bottom:0; - text-align:center; - border-top: 1px solid #fff; -} -#footer a { - color: White; -} -dt { - font-weight:bold; -} |
