README.txt 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. //============================================================
  2. //= rAthena Readme File
  3. //===== By: ==================================================
  4. //= rAthena Dev Team
  5. //===== Current Version: =====================================
  6. //= $Revision$
  7. //===== Last Updated: ========================================
  8. //= $LastChangedDate$
  9. //===== Description: =========================================
  10. //= Basic information and installation guide with links to
  11. //= various forum posts and Wiki articles.
  12. //============================================================
  13. ============================
  14. || Table of Contents ||
  15. ============================
  16. || 1. What is rAthena? ||
  17. || 2. Prerequisites ||
  18. || 3. Installation ||
  19. || 4. Troubleshooting ||
  20. || 5. Helpful Links ||
  21. || 6. More Documentation ||
  22. ============================
  23. ============================
  24. || 1. What is rAthena? ||
  25. ============================
  26. rAthena is a collaborative software development project revolving around the
  27. creation of a robust massively multiplayer online role playing game (MMORPG)
  28. server package. Written in C, the program is very versatile and provides NPCs,
  29. warps and modifications. The project is jointly managed by a group of volunteers
  30. located around the world as well as a tremendous community providing QA and
  31. support. rAthena is a continuation of the eAthena project.
  32. ============================
  33. || 2. Prerequisites ||
  34. ============================
  35. Before installing rAthena there are certain tools and applications you will need.
  36. This differs between the varying operating systems available, so the following
  37. is broken down into Windows and Linux prerequisites.
  38. Windows
  39. * MySQL (http://www.mysql.com/downloads/mysql/)
  40. * MySQL Workbench (http://www.mysql.com/downloads/workbench/)
  41. * MS Visual C++ (http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express)
  42. * [svn] TortoiseSVN (http://tortoisesvn.net/downloads.html)
  43. * [git] TortoiseGIT (http://code.google.com/p/tortoisegit/)
  44. * [git] MSysGit (http://code.google.com/p/msysgit/downloads/)
  45. Linux (names of packages may require specific version numbers on certain distributions)
  46. * gcc
  47. * make
  48. * mysql
  49. * mysql-devel
  50. * mysql-server
  51. * pcre-devel
  52. * zlib-devel
  53. * [svn] subversion
  54. * [git] git
  55. ============================
  56. || 3. Installation ||
  57. ============================
  58. This section is a very brief set of installation instructions. For more concise guides
  59. relevant to your Operation System, please refer to the Wiki (links at the end of this file).
  60. Windows
  61. * Install prerequisites
  62. * Create a folder to download rAthena into (e.g. C:\rAthena)
  63. * Right click this folder and select:
  64. [svn] "SVN Checkout"
  65. [git] "Git Clone"
  66. * Paste the SVN URL into the box:
  67. [svn] https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/
  68. [git] https://github.com/rathena/rathena.git
  69. * Open MySQL Workbench and create an instance to connect to your MySQL Server
  70. * Create a database (rathena), a user (rathena), give permissions (GRANT SELECT,INSERT,UPDATE,DELETE)
  71. and then login using the new user
  72. * Use MySQL Workbench to run the .sql files in /sql-files/ on the new rathena database
  73. Linux
  74. * Type:
  75. (For CentOS)
  76. [svn] yum install gcc make mysql mysql-devel mysql-server pcre-devel subversion zlib-devel
  77. [git]
  78. yum install gcc make mysql mysql-devel mysql-server pcre-devel zlib-devel
  79. rpm -Uvhhttp://repo.webtatic.com/yum/centos/5/latest.rpm
  80. yum install --enablerepo=webtatic git-all
  81. yum install --enablerepo=webtatic --disableexcludes=main git-all
  82. (For Debian)
  83. [svn] apt-get install subversion make gcc libmysqlclient-dev zlib1g-dev libpcre3-dev
  84. [git] apt-get install git make gcc libmysqlclient-dev zlib1g-dev libpcre3-dev
  85. * Type: mysql_secure_installation
  86. * Start your MySQL server
  87. * Setup a MySQL user: CREATE USER 'rathena'@'localhost' IDENTIFIED BY 'password';
  88. * Assign permissions: GRANT SELECT,INSERT,UPDATE,DELETE ON `rathena\_rag`.* TO 'rathena'@'localhost';
  89. * Type:
  90. [svn] svn checkout https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ ~/trunk
  91. [git] git clone https://github.com/rathena/rathena.git ~/rathena
  92. * Insert SQL files: mysql --user=root -p rathena_rag < trunk/sql-files/main.sql (and others)
  93. * Type: cd trunk && ./configure && make clean && make sql
  94. * When you're ready, type: ./athena-start start
  95. ============================
  96. || 4. Troubleshooting ||
  97. ============================
  98. If you're having problems with starting your server, the first thing you should
  99. do is check what's happening on your consoles. More often that not, all support issues
  100. can be solved simply by looking at the error messages given.
  101. Examples:
  102. 1.) You get an error on your map-server_sql that looks something like this:
  103. [Error]: npc_parsesrcfile: Unable to parse, probably a missing or extra TAB in
  104. file 'npc/custom/jobmaster.txt', line '17'. Skipping line...
  105. * w1=prontera,153,193,6 script
  106. * w2=Job Master
  107. * w3=123,{
  108. * w4=
  109. If you look at the error, it's telling you that you're missing (or have an extra) TAB.
  110. This is easily fixed by looking at this part of the error: * w1=prontera,153,193,6 script
  111. If there was a TAB where it's supposed to be, that line would have prontera,153,193,6 at w1
  112. and 'script' at w2. As there's a space instead of a TAB, the two sections are read as a
  113. single parameter.
  114. 2.) You have a default user/password warning similar to the following:
  115. [Warning]: Using the default user/password s1/p1 is NOT RECOMMENDED.
  116. [Notice]: Please edit your 'login' table to create a proper inter-server user/pa
  117. ssword (gender 'S')
  118. [Notice]: and then edit your user/password in conf/map_athena.conf (or conf/impo
  119. rt/map_conf.txt)
  120. Relax. This is just indicating that you're using the default username and password. To
  121. fix this, check over the part in the installation instructions relevant to the `login` table.
  122. 3.) Your map-server outputs the following:
  123. [Error]: make_connection: connect failed (socket #2, error 10061: No connection
  124. could be made because the target machine actively refused it.
  125. )!
  126. If this shows up on the map server, it generally means that there is no Char Server available
  127. to accept the connection.
  128. ============================
  129. || 5. Helpful Links ||
  130. ============================
  131. The following list of links point to various help files within the SVN, articles or
  132. pages on the Wiki or topics within the rAthena forum.
  133. * rAthena Forums
  134. http://rathena.org/
  135. * SVN Repository
  136. https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/
  137. * GIT Repository
  138. https://github.com/rathena/rathena
  139. * Full Installation Instructions
  140. Windows http://rathena.org/wiki/Installation_on_Windows
  141. CentOS http://rathena.org/wiki/Installation_(CentOS)
  142. Debian http://rathena.org/wiki/Installation_(Debian)
  143. * rAthena IRC Channel
  144. irc://irc.rizon.net/rathena
  145. ============================
  146. || 6. More Documentation ||
  147. ============================
  148. rAthena has a large collection of help files and sample NPC scripts located in the /doc/
  149. directory. These include detailed explanations of NPC script commands, atcommands (@),
  150. group permissions, item bonuses, and packet structures, among many other topics. We
  151. recommend that all users take the time to look over this directory before asking for
  152. assistance elsewhere.