README.txt 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  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. * TortoiseSVN (http://tortoisesvn.net/downloads.html)
  40. * MySQL (http://www.mysql.com/downloads/mysql/)
  41. * MySQL Workbench (http://www.mysql.com/downloads/workbench/)
  42. * MS Visual C++ (http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express)
  43. Linux (names of packages may require specific version numbers on certain distributions)
  44. * gcc
  45. * make
  46. * mysql
  47. * mysql-devel
  48. * mysql-server
  49. * pcre-devel
  50. * subversion
  51. * zlib-devel
  52. ============================
  53. || 3. Installation ||
  54. ============================
  55. This section is a very brief set of installation instructions. For more concise guides
  56. relevant to your Operation System, please refer to the Wiki (links at the end of this file).
  57. Windows
  58. * Install prerequisites
  59. * Create a folder to download rAthena into (e.g. C:\rAthena)
  60. * Right click this folder and select "SVN Checkout".
  61. * Paste the SVN URL into the box: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/
  62. * Open MySQL Workbench and create an instance to connect to your MySQL Server
  63. * Create a database (rathena), a user (rathena), give permissions (GRANT SELECT,INSERT,UPDATE,DELETE)
  64. and then login using the new user
  65. * Use MySQL Workbench to run the .sql files in /sql-files/ on the new rathena database
  66. Linux
  67. (For CentOS) Type: yum install gcc make mysql mysql-devel mysql-server pcre-devel subversion zlib-devel
  68. (For Debian) Type: apt-get install subversion make gcc libmysqlclient-dev zlib1g-dev libpcre3-dev
  69. * Type: mysql_secure_installation
  70. * Start your MySQL server
  71. * Setup a MySQL user: CREATE USER 'rathena'@'localhost' IDENTIFIED BY 'password';
  72. * Assign permissions: GRANT SELECT,INSERT,UPDATE,DELETE ON `rathena\_rag`.* TO 'rathena'@'localhost';
  73. * Type: svn checkout https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ ~/trunk
  74. * Insert SQL files: mysql --user=root -p rathena_rag < trunk/sql-files/main.sql (and others)
  75. * Type: cd trunk && ./configure && make clean && make sql
  76. * When you're ready, type: ./athena-start start
  77. ============================
  78. || 4. Troubleshooting ||
  79. ============================
  80. If you're having problems with starting your server, the first thing you should
  81. do is check what's happening on your consoles. More often that not, all support issues
  82. can be solved simply by looking at the error messages given.
  83. Examples:
  84. 1.) You get an error on your map-server_sql that looks something like this:
  85. [Error]: npc_parsesrcfile: Unable to parse, probably a missing or extra TAB in
  86. file 'npc/custom/jobmaster.txt', line '17'. Skipping line...
  87. * w1=prontera,153,193,6 script
  88. * w2=Job Master
  89. * w3=123,{
  90. * w4=
  91. If you look at the error, it's telling you that you're missing (or have an extra) TAB.
  92. This is easily fixed by looking at this part of the error: * w1=prontera,153,193,6 script
  93. If there was a TAB where it's supposed to be, that line would have prontera,153,193,6 at w1
  94. and 'script' at w2. As there's a space instead of a TAB, the two sections are read as a
  95. single parameter.
  96. 2.) You have a default user/password warning similar to the following:
  97. [Warning]: Using the default user/password s1/p1 is NOT RECOMMENDED.
  98. [Notice]: Please edit your 'login' table to create a proper inter-server user/pa
  99. ssword (gender 'S')
  100. [Notice]: and then edit your user/password in conf/map_athena.conf (or conf/impo
  101. rt/map_conf.txt)
  102. Relax. This is just indicating that you're using the default username and password. To
  103. fix this, check over the part in the installation instructions relevant to the `login` table.
  104. 3.) Your map-server outputs the following:
  105. [Error]: make_connection: connect failed (socket #2, error 10061: No connection
  106. could be made because the target machine actively refused it.
  107. )!
  108. If this shows up on the map server, it generally means that there is no Char Server available
  109. to accept the connection.
  110. ============================
  111. || 5. Helpful Links ||
  112. ============================
  113. The following list of links point to various help files within the SVN, articles or
  114. pages on the Wiki or topics within the rAthena forum.
  115. * rAthena Forums
  116. http://rathena.org/
  117. * SVN Repository
  118. https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/
  119. * Full Installation Instructions
  120. Windows http://rathena.org/wiki/Installation_on_Windows
  121. CentOS http://rathena.org/wiki/Installation_(CentOS)
  122. Debian http://rathena.org/wiki/Installation_(Debian)
  123. * rAthena IRC Channel
  124. irc://irc.rizon.net/rathena
  125. ============================
  126. || 6. More Documentation ||
  127. ============================
  128. rAthena has a large collection of help files and sample NPC scripts located in the /doc/
  129. directory. These include detailed explanations of NPC script commands, atcommands (@),
  130. group permissions, item bonuses, and packet structures, among many other topics. We
  131. recommend that all users take the time to look over this directory before asking for
  132. assistance elsewhere.