From ce39f7431b07728ea9e61e48728eb327c749402a Mon Sep 17 00:00:00 2001 From: thatakkarin Date: Thu, 29 Nov 2012 01:04:29 +0000 Subject: * Removed readme html files and replaced with README.txt after looking at the poll on tid:71432 - there was nothing in the ~600kb that couldn't be summed up in ~8kb. The poll suggested no one really used them, so they're not staying. * Changed readme file to .txt for easy viewing on both *nix and Windows OS's. git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@16976 54d463be-8e91-2dee-dedb-b68131a5f0ec --- README.txt | 177 ++++++++++++++++++++++++++++++++++++++++++++++++ readme.html | 43 ------------ readme/commands.html | 34 ---------- readme/faq.html | 66 ------------------ readme/images/bg.gif | Bin 3121 -> 0 bytes readme/images/clown.png | Bin 590954 -> 0 bytes readme/resources.html | 60 ---------------- readme/scripting.html | 65 ------------------ readme/setup.html | 64 ----------------- readme/style.css | 83 ----------------------- 10 files changed, 177 insertions(+), 415 deletions(-) create mode 100644 README.txt delete mode 100644 readme.html delete mode 100644 readme/commands.html delete mode 100644 readme/faq.html delete mode 100644 readme/images/bg.gif delete mode 100644 readme/images/clown.png delete mode 100644 readme/resources.html delete mode 100644 readme/scripting.html delete mode 100644 readme/setup.html delete mode 100644 readme/style.css 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 @@ - - - - rAthena | Intro - - - - -
- - - -
-
    -
  • 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. -
    • -
- - -
- - -
- - 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 @@ - - - - rAthena | GM Commands - - - - -
- - - -
- The following are the GM Commands which can be used in-game on an rAthena server.

-

- -
- - -
- - 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 @@ - - - - rAthena | FAQ - - - - -
- - - -
- The following are frequently asked questions regarding rAthena.

-
-
Where can I set the exp rates?
-
-
    -
  • Go to /conf/battle/exp.conf
    • -
  • Find base_exp_rate and job_exp_rate. Change the value there to raise or lower the rates.
    • -
  • 100 = 1x, 1000 = 10x rates, etc
    • -
-
- -
Where can I set the item drop rates?
-
-
    -
  • Go to /conf/battle/drops.conf
    • -
  • You can set the drop rates by changing the values:
    - - item_rate_common: 100 <-- 100 = 1x drop rate, 1000 = 10x drop rate, etc
    - item_rate_common_boss: 100 <--- drop rate for bosses
    - item_drop_common_min: 1 <--- minimal drop rate
    - item_drop_common_max: 10000 <--- maximum drop rate. -
    - (You can set the rates of different items in the same file) -
-
- -
I found a bug, where to I report it?
-
If you find a bug in rAthena, report it here: Bug Tracker
- -
I'm a well-experienced programmer, can I join the rAthena dev team?
-
You can apply in the Developer Applications topic.
- -
My character won't move, and no windows open when I login to the game, what's wrong?
-
Your packet_db_ver is most likely set wrong, change it in /db/packet_db.txt to match your client's packet ver.
-
-
- - -
- - diff --git a/readme/images/bg.gif b/readme/images/bg.gif deleted file mode 100644 index 6c8c92c3b..000000000 Binary files a/readme/images/bg.gif and /dev/null differ diff --git a/readme/images/clown.png b/readme/images/clown.png deleted file mode 100644 index 55de4ba60..000000000 Binary files a/readme/images/clown.png and /dev/null differ 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 @@ - - - - rAthena | Resources - - - - -
- - - -
- The following are some links to various resources which can be helpful when using rAthena.
- -
- - -
- - 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 @@ - - - - rAthena | Scripting - - - - -
- - - -
- How to create an NPC using rAthena's scripting:

- map_name,x_cord,y_cord,npc_facing_direction -TAB- script -TAB- NPC Name#HiddenName -TAB- Sprite ID,{
-    mes "[NPC Name]";
-    mes "Hello World";
-    close;
- }

- - Common Script Commands: -
    -
  • mes "<message>";
    - displays a line of text in an NPC's dialog window.
    • -
  • close;
    - displays a "Close" button in an NPC's dialog window. -
    • -
  • next;
    - displays a "Next" button in an NPC's dialog window. -
    • -
  • getitem <item id>,<amount>;
    - gives the player an item. -
    • -
  • delitem <item id>,<amount>;
    - deletes an item from the player. -
    • -
- Script Command Documentation:
- All the script commands in rAthena can be found here.

- How to enable your NPC: -
    -
  1. Save it as a text file in your /npc/custom/ folder.
    2. -
  2. Open /npc/scripts_custom.conf
    3. -
  3. Add the following line:
    - npc: npc/custom/name_of_your_text_file.txt
    4. -
  4. Save and close.
    5. -
-
- - -
- - 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 @@ - - - - rAthena | Setup - - - - -
- - - -
- Character Server: -
    -
  1. Open /conf/char_athena.conf
    2. -
  2. Change userid and passwd (s1/p1) to what you want your server's communication details to be.
    3. -
  3. Change Server_Name to what you want to call your server.
    4. -
  4. Remove the // before login_ip. -
  5. Remove the // before char_ip and change 127.0.0.1 to your WAN IP. -
- - Map Server: -
    -
  1. Open /conf/map_athena.conf
    2. -
  2. Change userid and passwd to the same thing you set in char_athena.
    3. -
  3. Remove the // before char_ip.
    4. -
  4. Remove the // before map_ip and change 127.0.0.1 to your WAN IP. -
- - Subnet: -
    -
  1. Open /conf/subnet_athena.conf
    2. -
  2. Change 255.0.0.0 to your "Subnet Mask", change the two 127.0.0.1 to your LAN IP. -
- - MySQL Settings: -
    -
  1. Open /conf/inter_athena.conf
    2. -
  2. Find the "Global SQL Settings" and change them to your SQL server's settings.
    3. -
- - Message of the Day: -
    -
  1. Open /conf/motd.txt and edit it to change the in-game MOTD.
    2. -
-
- - -
- - 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; -} -- cgit v1.2.3-70-g09d2