Mirroristas/rathena
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- Standardized headers of /doc files.

Browse Source 
- Added svn:eol-style=native property on some recently added text files.

git-svn-id: https://svn.code.sf.net/p/rathena/svn/trunk@16726 54d463be-8e91-2dee-dedb-b68131a5f0ec
This commit is contained in:
brianluau 2012-08-31 21:49:48 +00:00
parent b2029010bb
commit 9b08202837
15 changed files with 893 additions and 903 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/atcommands.txt
View File

@ -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.

27
doc/ea_job_system.txt
View File

@ -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:

10
doc/effect_list.txt
View File

@ -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).

39
doc/item_bonus.txt
View File

@ -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.)
bonus2 bVariableCastrate,s,x; Increases variable cast time of skill s by x%. (supports skill names.)

12
doc/item_db.txt
View File

@ -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

16
doc/map_cache.txt
View File

@ -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:
-------------------------------------------------------------------------------

18
doc/mob_db_mode_list.txt
View File

@ -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:
-------------------------------------------------------------------------------

15
doc/packet_struct_notation.txt
View File

@ -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

16
doc/permissions.txt
View File

@ -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.
disable_pvp: Ability to disable Player v.s. Player.

185
doc/quest_variables.txt
View File

@ -1,114 +1,109 @@
--------------------------------------------------------------
- Permanent Quest Variables -
--------------------------------------------------------------
//===== 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
//============================================================
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]
--------------------------------------------------------------
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) {}
--------------------------------------------------------------
Variable: MISC_QUEST
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: -
Info: -
How to set: set MISC_QUEST, MISC_QUEST | 256;
How to check: if (MISC_QUEST & 256) {}
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: 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: -
Info: -
How to set: set MISC_QUEST,MISC_QUEST | 256;
How to check: if(MISC_QUEST & 256){}
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: 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: 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: Reset Skills Event
Info: Yuno, Hypnotist Teacher
How to set: set MISC_QUEST,MISC_QUEST | 1024;
How to check: if(MISC_QUEST & 1024){}
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: 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: 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: 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: 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: 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: 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: 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: 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: 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 & ?){}
--------------------------------------------------------------
//============================================================
Quest: ?
Info: ?
How to set: set MISC_QUEST, MISC_QUEST | ?;
How to check: if (MISC_QUEST & ?) {}

2
doc/script_commands.txt
View File

@ -1,4 +1,4 @@
//===== rAthena Doc ===========================================
//===== rAthena Documentation ================================
//= rAthena Script Commands
//===== By: ==================================================
//= rAthena Dev Team

22
doc/whisper_sys.txt
View File

@ -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;
}
}

16
doc/woe_time_explanation.txt
View File

@ -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>).

1402
npc/kafras/kafras.txt
View File

File diff suppressed because it is too large Load Diff

2
sql-files/upgrade_svn16663.sql
View File

@ -1 +1 @@
ALTER TABLE `homunculus` ADD `prev_class` MEDIUMINT( 9 ) NOT NULL AFTER `class`
ALTER TABLE `homunculus` ADD `prev_class` MEDIUMINT( 9 ) NOT NULL AFTER `class`