diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/atcommands.txt | 14 | ||||
| -rw-r--r-- | doc/ea_job_system.txt | 27 | ||||
| -rw-r--r-- | doc/effect_list.txt | 10 | ||||
| -rw-r--r-- | doc/item_bonus.txt | 39 | ||||
| -rw-r--r-- | doc/item_db.txt | 12 | ||||
| -rw-r--r-- | doc/map_cache.txt | 16 | ||||
| -rw-r--r-- | doc/mob_db_mode_list.txt | 18 | ||||
| -rw-r--r-- | doc/packet_struct_notation.txt | 15 | ||||
| -rw-r--r-- | doc/permissions.txt | 16 | ||||
| -rw-r--r-- | doc/quest_variables.txt | 223 | ||||
| -rw-r--r-- | doc/script_commands.txt | 2 | ||||
| -rw-r--r-- | doc/whisper_sys.txt | 22 | ||||
| -rw-r--r-- | doc/woe_time_explanation.txt | 16 |
13 files changed, 210 insertions, 220 deletions
diff --git a/doc/atcommands.txt b/doc/atcommands.txt index 2983e0316..d9f992abc 100644 --- a/doc/atcommands.txt +++ b/doc/atcommands.txt @@ -1,5 +1,15 @@ -TODO: With such short descriptions, it's duplicated 'conf/help.txt' -Consider explaining commands in detail, similar to 'doc/script_commands.txt' +//===== rAthena Documentation ================================ +//= Atcommand List +//===== By: ================================================== +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20120824 +//===== Description: ========================================= +//= +//===== Additional Comments: ================================= +//= TODO: With such short descriptions, it's duplicated 'conf/help.txt' +//= Consider explaining commands in detail, similar to 'doc/script_commands.txt' +//============================================================ commands: Displays a list of @ commands available to the player. charcommands: Displays a list of # commands available to the player. diff --git a/doc/ea_job_system.txt b/doc/ea_job_system.txt index 3fd7e9bb9..d483c5639 100644 --- a/doc/ea_job_system.txt +++ b/doc/ea_job_system.txt @@ -1,17 +1,16 @@ -//===== Athena Doc========================================= -//= eAthena Job System -//===== By ================================================ +//===== rAthena Documentation ================================ +//= *Athena Job System +//===== By: ================================================== //= Skotlex -//===== Version =========================================== +//===== Current Version: ===================================== //= 0.2 -//========================================================= +//===== Description: ========================================= +//= A reference description of eA's inner job system (for use +//= on scripts through the eaclass and roclass script commands) +//===== Additional Comments: ================================= //= 0.1 - First release, explained as well as I could. //= 0.2 - Added info on third jobs. [Euphy] -//===== Description ======================================= -//= A reference description of eA's inner job system (for -//= use on scripts through the eaclass and roclass script -//= commands) -//========================================================= +//============================================================ Preface: ------------------------------------------------------------------------------- @@ -185,10 +184,10 @@ About Bards and Dancers: About Novices and Super Novices: These are treated a bit differently from you'd expect. Because.. for instance, a novice is not supposed to be a 1st class, but it is considered as one on this tree system: - EAJ_NOVICE -> Novice - EAJ_NOVICE|EAJL_2_1 -> EAJ_SUPER_NOVICE - EAJ_NOVICE|EAJL_UPPER -> EAJ_NOVICE_HIGH - EAJ_NOVICE|EAJL_BABY -> EAJ_BABY + EAJ_NOVICE -> Novice + EAJ_NOVICE|EAJL_2_1 -> EAJ_SUPER_NOVICE + EAJ_NOVICE|EAJL_UPPER -> EAJ_NOVICE_HIGH + EAJ_NOVICE|EAJL_BABY -> EAJ_BABY EAJ_NOVICE|EAJL_BABY|EAJL_2_1 -> EAJ_SUPER_BABY So as you can see, on this job system, the Super Novice is treated as the 2-1 job of a Novice, and the Novice job it's at the same level of the other 1st jobs. Even though that may seem like a hindrance, it makes it very easy to add a check to discard Novice types from a quest: diff --git a/doc/effect_list.txt b/doc/effect_list.txt index 2372c894a..b1b591a22 100644 --- a/doc/effect_list.txt +++ b/doc/effect_list.txt @@ -1,8 +1,12 @@ -//===== Athena Doc ======================================== +//===== rAthena Documentation ================================ //= Client Effects List -//===== Description ======================================= +//===== By: ================================================== +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20120822 +//===== Description: ========================================= //= A list of client-side effects sorted by their ID -//========================================================= +//============================================================ The following is a compiled list of visual and sound effects which the client can produce when receiving a packet with id 0x1f3 (01f3 <ID>.l <type>.l). diff --git a/doc/item_bonus.txt b/doc/item_bonus.txt index fff5fb540..8f798db85 100644 --- a/doc/item_bonus.txt +++ b/doc/item_bonus.txt @@ -1,36 +1,13 @@ -//===== Athena Doc ======================================== +//===== rAthena Documentation ================================ //= rAthena Item Bonuses List -//===== By ================================================ -//= Developers -//===== Version =========================================== -//= 1.1.20110124 -//========================================================= -//= 1.0 - Standardized doc file -//= 1.1.20080612 - skill command and bonuses (bAutoSpell, bSkillAtk, -//= bSkillHeal, bAutoSpellWhenHit, bAddSkillBlow, bCastrate) accept -//= skill names [FlavioJS] -//= 1.1.20090122 - removed outdated bSPDrainValue command [ultramage] -//= 1.1.20090421 - added the correct bonus documentation for bSPDrainValue [Playtester] -//= 1.1.20090524 - removed outdated bMatk/bMatk1/bMatk2 doc [ultramage] -//= 1.1.20090529 - added documentation for bHealPower, bHealPower2 [Inkfish] -//= 1.1.20101130 - added documentation for bAutoSpellOnSkill [Ai4rei] -//= 1.1.20101205 - added documentation for bAddItemHealRate. [L0ne_W0lf] -//= 1.1.20101207 - added documentation for bUnbreakableGarment, -//= bUnbreakableWeapon, bUnbreakableArmor, bUnbreakableHelm, -//= bUnbreakableShield, bUnbreakableShoes, bBreakWeaponRate and -//= bBreakArmorRate. [Ai4rei] -//= 1.1.20110124 - added documentation for bAgiVit, bAgiDexStr, -//= bUnbreakable, bShortWeaponDamageReturn, bLongWeaponDamageReturn, -//= bWeaponComaEle, bAddEff2, bMagicDamageReturn, bRandomAttackIncrease, -//= bPerfectHide, bNoKnockback, bClassChange, bHPDrainValue, bWeaponAtk, -//= bWeaponAtkRate, bDelayrate, bHPDrainRateRace, bSPDrainRateRace, -//= bAddEffOnSkill, bNoMiscDamage, bLongAtkRate, bUnstripable, -//= bHPDrainValueRace, bMagicSPGainValue and bMagicHPGainValue. [Ai4rei] -//===== Description ======================================= +//===== By: ================================================== +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20110124 +//===== Description: ========================================= //= List of script instructions used in item bonuses, //= mainly bonus/bonus2/bonus3/bonus4/bonus5 arguments -//========================================================= - +//============================================================ skill i,n; Gives skill #i at level n (supports skill names) @@ -434,4 +411,4 @@ bonus bFixedCastrate,x; Increases fixed cast time of skills by x%. bonus bVariableCastrate,x; Increases variable cast time of skills by x%. bonus2 bSkillFixedCast,s,x; Increases fixed cast time of skill s by x milliseconds. (supports skill names.) bonus2 bSkillVariableCast,s,x; Increases variable cast time of skill s by x milliseconds. (supports skill names.) -bonus2 bVariableCastrate,s,x; Increases variable cast time of skill s by x%. (supports skill names.)
\ No newline at end of file +bonus2 bVariableCastrate,s,x; Increases variable cast time of skill s by x%. (supports skill names.) diff --git a/doc/item_db.txt b/doc/item_db.txt index 83c9d1507..ddbac4238 100644 --- a/doc/item_db.txt +++ b/doc/item_db.txt @@ -1,6 +1,12 @@ -(FIXME: Someone give this file better formatting) - -- Explanation of the item_db.txt file and structure. +//===== rAthena Documentation ================================ +//= Item Database +//===== By: ================================================== +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20120420 +//===== Description: ========================================= +//= Explanation of the item_db.txt file and structure. +//============================================================ ID: Item id diff --git a/doc/map_cache.txt b/doc/map_cache.txt index 8f9505fa8..d109a4f5f 100644 --- a/doc/map_cache.txt +++ b/doc/map_cache.txt @@ -1,16 +1,16 @@ -//===== Athena Doc ======================================== +//===== rAthena Documentation ================================ //= rAthena Map Cache Builder and Format Documentation -//===== By ================================================ +//===== By: ================================================== //= DracoRPG -//===== Version =========================================== +//===== Current Version: ===================================== //= 1.0 -//========================================================= +//===== Description: ========================================= +//= A complete manual for rAthena's map cache generator as +//= well as a reference on the map cache format used. +//===== Additional Comments: ================================= //= 0.1 - Short howto for the initial builder version //= 1.0 - Complete manual covering the improved version -//===== Description ======================================= -//= A complete manual for rAthena's map cache generator -//= as well as a reference on the map cache format used -//========================================================= +//============================================================ Preface: ------------------------------------------------------------------------------- diff --git a/doc/mob_db_mode_list.txt b/doc/mob_db_mode_list.txt index 34a5dac89..4c2b85e4a 100644 --- a/doc/mob_db_mode_list.txt +++ b/doc/mob_db_mode_list.txt @@ -1,14 +1,12 @@ -//===== Athena Doc ======================================== +//===== rAthena Documentation ================================ //= rAthena Monster Modes Reference -//===== By ================================================ -//= Developers -//===== Version =========================================== -//= 1.0 -//========================================================= -//= 1.0 - Standardized doc file -//===== Description ======================================= -//= A reference description of rAthena's mob_db 'mode' field -//========================================================= +//===== By: ================================================== +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20120630 +//===== Description: ========================================= +//= A reference description of rAthena's mob_db 'mode' field. +//============================================================ Bit Legend: ------------------------------------------------------------------------------- diff --git a/doc/packet_struct_notation.txt b/doc/packet_struct_notation.txt index 0ce87289c..25951acb5 100644 --- a/doc/packet_struct_notation.txt +++ b/doc/packet_struct_notation.txt @@ -1,15 +1,12 @@ -//===== Athena Doc ======================================== +//===== rAthena Documentation ================================ //= Packet Structure Notation -//===== By ================================================ +//===== By: ================================================== //= Ai4rei -//===== Version =========================================== -//= 1.1 -//========================================================= -//= 1.0 - Initial version. -//= 1.1 - Added examples. -//===== Description ======================================= +//===== Current Version: ===================================== +//= 20120810 +//===== Description: ========================================= //= Explanation how packets are and should be documented. -//========================================================= +//============================================================ This document specifies how packets are and should be documented, to keep packet structure comments consistent in the entire codebase. It diff --git a/doc/permissions.txt b/doc/permissions.txt index e3e44ef7f..31592828b 100644 --- a/doc/permissions.txt +++ b/doc/permissions.txt @@ -1,4 +1,12 @@ -These are possible permissions of player groups, configured in conf/groups.conf. +//===== rAthena Documentation ================================ +//= Permission List +//===== By: ================================================== +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20120718 +//===== Description: ========================================= +//= permissions of player groups, configured in /conf/groups.conf +//============================================================ can_trade : Ability to trade or otherwise distribute items (drop, storage, vending etc) can_party : Ability to join parties. @@ -11,8 +19,8 @@ hide_session : Hides player session from being displayed by @commands. who_display_aid : Ability to see GMs and Account/Char IDs in the @who command. hack_info : Ability to receive all informations about any player that try to hack, spoof a name, etc. any_warp : Ability to bypass nowarp, nowarpto, noteleport and nomemo mapflags. - This option is mainly used in commands which modify a character's - map/coordinates (like @memo, @mapmove, @go, @jump, etc...). + This option is mainly used in commands which modify a character's + map/coordinates (like @memo, @mapmove, @go, @jump, etc...). view_hpmeter : Ability to see HP bar of every player. view_equipment : Ability to view players equipment regardless of their setting. use_check : Ability to use client command /check (display character status). @@ -21,4 +29,4 @@ all_commands: Ability to use ALL atcommands/charcommands. receive_requests: Ability to receive @requests. show_bossmobs: Ability to see boss mobs with @showmobs. disable_pvm: Ability to disable Player v.s. Monster. -disable_pvp: Ability to disable Player v.s. Player.
\ No newline at end of file +disable_pvp: Ability to disable Player v.s. Player. diff --git a/doc/quest_variables.txt b/doc/quest_variables.txt index d100895b1..27a039e37 100644 --- a/doc/quest_variables.txt +++ b/doc/quest_variables.txt @@ -1,114 +1,109 @@ --------------------------------------------------------------- -- Permanent Quest Variables - --------------------------------------------------------------- - -This file should help to understand and manage bit-wise quest -variables. You can store up to 31 boolean value into a single -variable. [Lupus] --------------------------------------------------------------- - --------------------------------------------------------------- -Variable: MISC_QUEST - -Quest: Juice Maker Quest -Info: How to make juices. This bit keeps final state of the quest. -How to set: set MISC_QUEST,MISC_QUEST | 1; -How to check: if(MISC_QUEST & 1){} - -Quest: Tempestra Quest -Info: Has you given a potion to Temperstra or not. -How to set: set MISC_QUEST,MISC_QUEST | 2; -How to check: if(MISC_QUEST & 2){} - -Quest: Morgenstein Quest -Info: How to make Mixture & Counteragent. Also subquest for Alchemist Job - This bit keeps final state of the quest. -How to set: set MISC_QUEST,MISC_QUEST | 4; -How to check: if(MISC_QUEST & 4){} - -Quest: Prontera Culvert Quest -Info: Could you enter the Prontera Culvert or not. -How to set: set MISC_QUEST,MISC_QUEST | 8; -How to check: if(MISC_QUEST & 8){} - -Quest: Edgar's Offer -Info: Cheap ticket from Izlude to Alberta. - This bit keeps final state of the quest. -How to set: set MISC_QUEST,MISC_QUEST | 16; -How to check: if(MISC_QUEST & 16){} - -Quest: Piano Quest -Info: The only way from Niflheim to Umbala. -How to set: set MISC_QUEST,MISC_QUEST | 32; -How to check: if(MISC_QUEST & 32){} - -Quest: Bio Ethics Quest -Info: Bio Ethics quest for homunculus - skill for alchemists. This bit - is for final part of quest. - (completed or not.)[Evera] -How to set: set MISC_QUEST,MISC_QUEST|64; -How to check: if(MISC_QUEST&64){} - -Quest: DTS Warper -Info: Not really a quest, but to - show if a person has - already voted. Cleaning - up the variables -.-;[Evera] -How to set: set MISC_QUEST,MISC_QUEST|128; -How to check: if(MISC_QUEST&128){} - -Quest: - -Info: - -How to set: set MISC_QUEST,MISC_QUEST | 256; -How to check: if(MISC_QUEST & 256){} - -Quest: Cube Room -Info: Lighthalzen. Cube Room Quest (Pass to Bio-Lab) -How to set: set MISC_QUEST,MISC_QUEST | 512; -How to check: if(MISC_QUEST & 512){} - -Quest: Reset Skills Event -Info: Yuno, Hypnotist Teacher -How to set: set MISC_QUEST,MISC_QUEST | 1024; -How to check: if(MISC_QUEST & 1024){} - -Quest: Slotted Arm Guard Quest -Info: Ninja Job Room, Boshuu -How to set: set MISC_QUEST,MISC_QUEST | 2048; -How to check: if(MISC_QUEST & 2048){} - -Quest: Improved Arm Guard Quest -Info: Ninja Job Room, Basshu -How to set: set MISC_QUEST,MISC_QUEST | 4096; -How to check: if(MISC_QUEST & 4096){} - -Quest: Rachel Sanctuary Quest -Info: Gained access to Rachel Santuary (yes/no) -How to set: set MISC_QUEST,MISC_QUEST | 8192; -How to check: if(MISC_QUEST & 8192){} - -Quest: Message Delivery Quest -Info: Send a message to Elly, in Niflheim from Erious. -How to set: set MISC_QUEST,MISC_QUEST | 16384; -How to check: if(MISC_QUEST & 16384){} - -Quest: Umbala Domestic Dispute? -Info: Reward: 1 yggdrasil leaf. -How to set: set MISC_QUEST,MISC_QUEST | 32768; -How to check: if(MISC_QUEST & 32768){} - -Quest: Access to the Turtle Island -Info: Reward: ~1 OCA, OVB, GB, . -How to set: set MISC_QUEST,MISC_QUEST | 65536; -How to check: if(MISC_QUEST & 65536){} - --------------------------------------------------------------- -Variable: MISC_QUEST2 - -Quest: ? -Info: ? -How to set: set MISC_QUEST,MISC_QUEST | ?; -How to check: if(MISC_QUEST & ?){} - --------------------------------------------------------------- +//===== rAthena Documentation ================================ +//= Permanent Quest Variables +//===== By: ================================================== +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20120826 +//===== Description: ========================================= +//= This file should help to understand and manage bit-wise +//= quest variables. You can store up to 31 boolean value into +//= a single variable. +//===== Additional Comments: ================================= +//= Variable: MISC_QUEST +//============================================================ + +Quest: Juice Maker Quest +Info: How to make juices. This bit keeps final state of the quest. +How to set: set MISC_QUEST, MISC_QUEST | 1; +How to check: if (MISC_QUEST & 1) {} + +Quest: Tempestra Quest +Info: Has you given a potion to Temperstra or not. +How to set: set MISC_QUEST, MISC_QUEST | 2; +How to check: if (MISC_QUEST & 2) {} + +Quest: Morgenstein Quest +Info: How to make Mixture & Counteragent. Also subquest for Alchemist Job + This bit keeps final state of the quest. +How to set: set MISC_QUEST, MISC_QUEST | 4; +How to check: if (MISC_QUEST & 4) {} + +Quest: Prontera Culvert Quest +Info: Could you enter the Prontera Culvert or not. +How to set: set MISC_QUEST, MISC_QUEST | 8; +How to check: if (MISC_QUEST & 8) {} + +Quest: Edgar's Offer +Info: Cheap ticket from Izlude to Alberta. + This bit keeps final state of the quest. +How to set: set MISC_QUEST, MISC_QUEST | 16; +How to check: if (MISC_QUEST & 16) {} + +Quest: Piano Quest +Info: The only way from Niflheim to Umbala. +How to set: set MISC_QUEST, MISC_QUEST | 32; +How to check: if (MISC_QUEST & 32) {} + +Quest: Bio Ethics Quest +Info: Bio Ethics quest for homunculus skill for alchemists. + This bit is for final part of quest (completed or not). [Evera] +How to set: set MISC_QUEST, MISC_QUEST|64; +How to check: if (MISC_QUEST & 64) {} + +Quest: DTS Warper +Info: Not really a quest, but to show if a person has already voted. + Cleaning up the variables -.-; [Evera] +How to set: set MISC_QUEST, MISC_QUEST|128; +How to check: if (MISC_QUEST & 128) {} + +Quest: - +Info: - +How to set: set MISC_QUEST, MISC_QUEST | 256; +How to check: if (MISC_QUEST & 256) {} + +Quest: Cube Room +Info: Lighthalzen. Cube Room Quest (Pass to Bio-Lab) +How to set: set MISC_QUEST, MISC_QUEST | 512; +How to check: if (MISC_QUEST & 512) {} + +Quest: Reset Skills Event +Info: Yuno, Hypnotist Teacher +How to set: set MISC_QUEST, MISC_QUEST | 1024; +How to check: if (MISC_QUEST & 1024) {} + +Quest: Slotted Arm Guard Quest +Info: Ninja Job Room, Boshuu +How to set: set MISC_QUEST, MISC_QUEST | 2048; +How to check: if (MISC_QUEST & 2048) {} + +Quest: Improved Arm Guard Quest +Info: Ninja Job Room, Basshu +How to set: set MISC_QUEST, MISC_QUEST | 4096; +How to check: if (MISC_QUEST & 4096) {} + +Quest: Rachel Sanctuary Quest +Info: Gained access to Rachel Santuary (yes/no) +How to set: set MISC_QUEST, MISC_QUEST | 8192; +How to check: if (MISC_QUEST & 8192) {} + +Quest: Message Delivery Quest +Info: Send a message to Elly, in Niflheim from Erious. +How to set: set MISC_QUEST, MISC_QUEST | 16384; +How to check: if (MISC_QUEST & 16384) {} + +Quest: Umbala Domestic Dispute? +Info: Reward: 1 yggdrasil leaf. +How to set: set MISC_QUEST, MISC_QUEST | 32768; +How to check: if (MISC_QUEST & 32768) {} + +Quest: Access to the Turtle Island +Info: Reward: ~1 OCA, OVB, GB. +How to set: set MISC_QUEST, MISC_QUEST | 65536; +How to check: if (MISC_QUEST & 65536) {} + + +//============================================================ +Quest: ? +Info: ? +How to set: set MISC_QUEST, MISC_QUEST | ?; +How to check: if (MISC_QUEST & ?) {} diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 5f461ec1b..7186fdb28 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -1,4 +1,4 @@ -//===== rAthena Doc =========================================== +//===== rAthena Documentation ================================ //= rAthena Script Commands //===== By: ================================================== //= rAthena Dev Team diff --git a/doc/whisper_sys.txt b/doc/whisper_sys.txt index 115712eea..906dad81b 100644 --- a/doc/whisper_sys.txt +++ b/doc/whisper_sys.txt @@ -1,17 +1,15 @@ -//===== Athena Doc ======================================== +//===== rAthena Documentation ================================ //= NPC Whisper System -//===== By ================================================ -//= lordalfa, Massdriller -//===== Version =========================================== -//= 1.1 -//========================================================= -//= 1.1 - Cleanup. [Euphy] -//===== Description ======================================= +//===== By: ================================================== +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20120826 +//===== Description: ========================================= //= A description of rAthena's NPC whispering system. -//========================================================= +//============================================================ -This piece of code to allows characters to execute events in NPCs by whispering -them up to ten parameters. The NPC must have an "OnWhisperGlobal" label, or an +This piece of code to allows characters to execute events in NPCs by whispering +them up to ten parameters. The NPC must have an "OnWhisperGlobal" label, or an "event not found" error will result. NPC:<NPC Name> <String>{#String 2{#...{#String 10}}} @@ -37,4 +35,4 @@ OnWhisperGlobal: if (@whispervar0$ == "Report") message @whispervar2$,"You have been reported for "+@whispervar1$+"."; end; -}
\ No newline at end of file +} diff --git a/doc/woe_time_explanation.txt b/doc/woe_time_explanation.txt index 57951e885..fa21834ad 100644 --- a/doc/woe_time_explanation.txt +++ b/doc/woe_time_explanation.txt @@ -1,14 +1,12 @@ -//===== Athena Doc ======================================== +//===== rAthena Documentation ================================ //= WoE Time Explanation -//===== By ================================================ -//= erKURITA -//===== Version =========================================== -//= 1.1 -//========================================================= -//= 1.1 - Edited and reformatted. [Euphy] -//===== Description ======================================= +//===== By: ================================================== +//= rAthena Dev Team +//===== Current Version: ===================================== +//= 20120717 +//===== Description: ========================================= //= Details on the behavior of the default WoE controller. -//========================================================= +//============================================================ There are 2 main commands that determine WoE times: OnClock<time>: and gettime(<type>). |