From d18de5aa04c825b96e3a3b87da3a167a9d90bd78 Mon Sep 17 00:00:00 2001 From: rathenabot Date: Thu, 18 Jul 2013 00:38:58 +0000 Subject: [PATCH] * Basic GIT integration: added .gitattributes, .gitignore, and README.md. * Edited README.txt with GIT installation instructions. Signed-off-by: Euphy git-svn-id: https://svn.code.sf.net/p/rathena/svn/trunk@17421 54d463be-8e91-2dee-dedb-b68131a5f0ec --- .gitattributes | 5 ++ .gitignore | 95 +++++++++++++++++++++++++++ README.md | 171 +++++++++++++++++++++++++++++++++++++++++++++++++ README.txt | 35 ++++++++-- 4 files changed, 299 insertions(+), 7 deletions(-) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000..a839a28c99 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +* text=auto +*.c diff=cpp +*.sln merge=union +*.vcproj merge=union +*.vcxproj merge=union \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..7506b2aa81 --- /dev/null +++ b/.gitignore @@ -0,0 +1,95 @@ +#Global +.DS_Store + +# / +/*.exe +/*.ilk +/*.log +/*.ncb +/*.opensdf +/*.opt +/*.pdb +/*.pid +/*.sdf +/*.stackdump +/*.suo +/char-server_sql +/config.log +/config.status +/core +/ipch +/login-server_sql +/Makefile +/Makefile.cache +/map-server_sql +/mapcache + +# /3rdparty/libconfig/ +/3rdparty/libconfig/Makefile +/3rdparty/libconfig/*.o + +# /3rdparty/mt19937ar/ +/3rdparty/mt19937ar/Makefile +/3rdparty/mt19937ar/*.o + +# /conf/ +/conf/import + +# /log/ +/log/*.log +/log/*.leaks + +# /src/char/ +/src/char/Makefile +/src/char/obj_sql + +# /src/common/ +/src/common/Makefile +/src/common/obj_all +/src/common/obj_sql +/src/common/svnversion.h + +# /src/login/ +/src/login/Makefile +/src/login/obj_sql + +# /src/map/ +/src/map/Makefile +/src/map/obj_sql +/src/map/pcre.h + +# /src/test/ +/src/test/Makefile +/src/test/obj + +# /src/tool/ +/src/tool/Makefile +/src/tool/obj_all + +# /tools/ +/tools/convert +/tools/adduser +/tools/*.exe +/tools/*.ilk +/tools/*.pdb + +# /vcproj-12/ +/vcproj-12/char-server_sql +/vcproj-12/login-server_sql +/vcproj-12/mapcache +/vcproj-12/map-server_sql +/vcproj-12/*.user + +# /vcproj-10/ +/vcproj-10/char-server_sql +/vcproj-10/login-server_sql +/vcproj-10/mapcache +/vcproj-10/map-server_sql +/vcproj-10/*.user + +# /vcproj-9/ +/vcproj-9/*.user +/vcproj-9/char-server_sql +/vcproj-9/login-server_sql +/vcproj-9/map-server_sql +/vcproj-9/mapcache diff --git a/README.md b/README.md new file mode 100644 index 0000000000..0a2988e4bd --- /dev/null +++ b/README.md @@ -0,0 +1,171 @@ +rAthena +======= +Table of Contents +--------- +* 1 What is rAthena? +* 2 Prerequisites +* 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. Prerequisites +--------- +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 prerequisites. + +* Windows + * 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 ) + * **[svn]** TortoiseSVN ( http://tortoisesvn.net/downloads.html ) + * **[git]** TortoiseGIT ( http://code.google.com/p/tortoisegit/ ) + * **[git]** MSysGit ( http://code.google.com/p/msysgit/downloads/ ) + +* Linux (names of packages may require specific version numbers on certain distributions) + * gcc + * make + * mysql + * mysql-devel + * mysql-server + * pcre-devel + * zlib-devel + * **[svn]** subversion + * **[git]** git + +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]** "SVN Checkout" + * **[git]** "Git Clone" + * Paste the SVN URL into the box: + * **[svn]** https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ + * **[git]** https://github.com/rathena/rathena.git + * 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 + * Type: + (For CentOS) + * **[svn]** yum install gcc make mysql mysql-devel mysql-server pcre-devel subversion zlib-devel + * **[git]** + * yum install gcc make mysql mysql-devel mysql-server pcre-devel zlib-devel + * rpm -Uvhhttp://repo.webtatic.com/yum/centos/5/latest.rpm + * yum install --enablerepo=webtatic git-all + * yum install --enablerepo=webtatic --disableexcludes=main git-all + (For Debian) + * **[svn]** apt-get install subversion make gcc libmysqlclient-dev zlib1g-dev libpcre3-dev + * **[git]** apt-get install git 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]** svn checkout https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ ~/trunk + * **[git]** git clone https://github.com/rathena/rathena.git ~/rathena + * 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: + +* 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. + +* 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. + +* Your map-server outputs 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 help files within the SVN, articles or +pages on the Wiki or topics within the rAthena forum. + +* rAthena Forums + http://rathena.org/ + +* SVN Repository + https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ + +* GIT Repository + https://github.com/rathena/rathena + +* 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.rizon.net/rathena + + +6. More Documentation +--------- +rAthena has a large collection of help files and sample NPC scripts located in the /doc/ +directory. These include detailed explanations of NPC script commands, atcommands (@), +group permissions, item bonuses, and packet structures, among many other topics. We +recommend that all users take the time to look over this directory before asking for +assistance elsewhere. diff --git a/README.txt b/README.txt index 3770fc498d..7b5b38c218 100644 --- a/README.txt +++ b/README.txt @@ -42,10 +42,12 @@ This differs between the varying operating systems available, so the following is broken down into Windows and Linux prerequisites. 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) + * [svn] TortoiseSVN (http://tortoisesvn.net/downloads.html) + * [git] TortoiseGIT (http://code.google.com/p/tortoisegit/) + * [git] MSysGit (http://code.google.com/p/msysgit/downloads/) Linux (names of packages may require specific version numbers on certain distributions) * gcc @@ -54,8 +56,9 @@ Linux (names of packages may require specific version numbers on certain distrib * mysql-devel * mysql-server * pcre-devel - * subversion * zlib-devel + * [svn] subversion + * [git] git ============================ @@ -67,21 +70,36 @@ relevant to your Operation System, please refer to the Wiki (links at the end of 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/ + * Right click this folder and select: + [svn] "SVN Checkout" + [git] "Git Clone" + * Paste the SVN URL into the box: + [svn] https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ + [git] https://github.com/rathena/rathena.git * 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: + (For CentOS) + [svn] yum install gcc make mysql mysql-devel mysql-server pcre-devel subversion zlib-devel + [git] + yum install gcc make mysql mysql-devel mysql-server pcre-devel zlib-devel + rpm -Uvhhttp://repo.webtatic.com/yum/centos/5/latest.rpm + yum install --enablerepo=webtatic git-all + yum install --enablerepo=webtatic --disableexcludes=main git-all + (For Debian) + [svn] apt-get install subversion make gcc libmysqlclient-dev zlib1g-dev libpcre3-dev + [git] apt-get install git 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 + * Type: + [svn] svn checkout https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ ~/trunk + [git] git clone https://github.com/rathena/rathena.git ~/rathena * 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 @@ -144,6 +162,9 @@ pages on the Wiki or topics within the rAthena forum. * SVN Repository https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ +* GIT Repository + https://github.com/rathena/rathena + * Full Installation Instructions Windows http://rathena.org/wiki/Installation_on_Windows CentOS http://rathena.org/wiki/Installation_(CentOS)