README.txt 6.6 KB

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