README.txt 7.1 KB

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