diff options
| -rw-r--r-- | README.txt | 104 | ||||
| -rw-r--r-- | doc/script_commands.txt | 21 |
2 files changed, 61 insertions, 64 deletions
diff --git a/README.txt b/README.txt index 485ea5857..37c8305c3 100644 --- a/README.txt +++ b/README.txt @@ -1,19 +1,19 @@ //============================================================ -//= rAthena ReadMe File +//= rAthena Readme File //===== By: ================================================== -//= rAthena Development Team -//===== Compatible With: ===================================== -//= rAthena SVN +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20121128 //===== Description: ========================================= //= Basic information and installation guide with links to -//= various forum posts and wiki articles. +//= various forum posts and Wiki articles. //============================================================ ============================ || Table of Contents || ============================ || 1. What is rAthena? || -|| 2. Prerequisits || +|| 2. Prerequisites || || 3. Installation || || 4. Troubleshooting || || 5. Helpful Links || @@ -24,7 +24,7 @@ ============================ || 1. What is rAthena? || ============================ - rAthena is a collaborative software development project revolving around the +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 @@ -34,34 +34,34 @@ support. rAthena is a continuation of the eAthena project. ============================ -|| 2. Prerequisists || +|| 2. Prerequisites || ============================ - Before installing rAthena there are certain tools and applications you will need. +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. +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) +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 +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 +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 @@ -91,7 +91,7 @@ Linux ============================ || 4. Troubleshooting || ============================ - If you're having problems with starting your server, the first thing you should +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. @@ -134,44 +134,44 @@ Examples: ============================ || 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. +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/ +* rAthena Forums + http://rathena.org/ - * SVN Repository URL: - https://rathena.svn.sourceforge.net/svnroot/rathena/trunk/ +* 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) +* 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 +* 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/ +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. +* 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 +* @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 explanation, 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 +* 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 +mapcache, or even explain how the job system and item bonuses work. Before posting a topic asking +for help on the forums, we recommend that all users take the time to look over this directory.
\ No newline at end of file diff --git a/doc/script_commands.txt b/doc/script_commands.txt index bbb988307..0362e5a87 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -6575,8 +6575,13 @@ The commands can also run without an attached rid. *bindatcmd("command","<NPC object name>::<event label>"{,<atcommand level>,<charcommand level>}); This command will bind a NPC event label to an atcommand. Upon execution of the -atcommand, the user will invoke the NPC event label. An array .@atcmd_parameters$[] -will be filled with the given parameters, starting with an index of 0. +atcommand, the user will invoke the NPC event label. Each atcommand is only allowed +one binding. If you rebind, it will override the original binding. + +The following variables are created upon execution: + .@atcmd_command$: The atcmd used. + .@atcmd_numparameters: The number of parameters defined. + .@atcmd_parameters$[]: Array containing the given parameters, starting from an index of 0. Example: @@ -6603,16 +6608,8 @@ This command will unbind a NPC event label from an atcommand. *useatcmd "command"; *useatcmd("command"); -This command will execute a custom atcommand on the attached RID from a script. -Whether invoked by a script or command, an array .@atcmd_parameters$[] will be -filled with the given parameters, starting with an index of 0. - -Example: - @test Testing Command - -The following array values will be generated: - .@atcmd_parameters$[0] = "Testing" - .@atcmd_parameters$[1] = "Command" +This command will execute an atcommand binding on the attached RID from a script. +Variables will not be created when invoking scripts with this command. --------------------------------------- |