From 9adc8abaa6ce3d5535b419fc2588a54d9755fe82 Mon Sep 17 00:00:00 2001 From: eaac Date: Thu, 13 Apr 2006 01:35:50 +0000 Subject: - Added up the locations but temporal names of Poring track npcs. Will be worked on over time. [erKURITA] - Fitted the many lines into 1 or 2, and corrected some typos on most of the npc\guides. Visual update to the guards, for short. [erKURITA] - Added some info to the docs.[erKURITA] - Added "case" npcs of lighthalzen, they're the first on npc/cities/? Mostly guards. [erKURITA] git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@6025 54d463be-8e91-2dee-dedb-b68131a5f0ec --- doc/conf_ref.txt | 17 +++- doc/help.txt | 29 +++++- doc/item_db.txt | 250 ++++++++++++++++++++++++------------------------ doc/pccommand_list.txt | 45 +++++++++ doc/script_commands.txt | 169 +++++++++++++++++++++++++++++--- 5 files changed, 371 insertions(+), 139 deletions(-) (limited to 'doc') diff --git a/doc/conf_ref.txt b/doc/conf_ref.txt index 88886d055..fc4cd72e6 100644 --- a/doc/conf_ref.txt +++ b/doc/conf_ref.txt @@ -15,7 +15,22 @@ although it is not a HowTo, it not Those who cannot use Athena even if they see char_athena.conf A setup of char-server inter_athena.conf A setup of inter-server map_athena.conf A setup of map-server - battle_athena.conf A setup of map-server (setup of a special rule etc.) + battle_athena.conf This file has been splitted into 13 files, separating them + depending on their function. Those files are: + + *battle.conf Regarding battle system configuration. + *client.conf Regarding client configuration. + *drops.conf Regarding mob drops configuration + *guild.conf Regarding guild configuration. + *monster.conf Regarding monsters guidance and settings. + *player.conf Regarding player and/or character settings. + *exp.conf Regarding exp settings. + *items.conf Regarding items settings. + *party.conf Regarding party settings. + *skill.conf Regarding skill settings + *gm.conf Regarding GM settings (not GM commands). + *misc.conf Regarding various settings (such as PK) + *pet.conf Regarding pet settings. atcommand_athena.conf A setup of map-server (setup of the GM command or @ command) ladmin_athena.conf A setup of ladmin ('c' version) diff --git a/doc/help.txt b/doc/help.txt index f5e735fec..49ad23506 100644 --- a/doc/help.txt +++ b/doc/help.txt @@ -1,5 +1,5 @@ GM Commands Help File -By Akaru +By Akaru (updated by erKURITA) ----------------------- To use these commands, type them inside the message window where you usually type to chat. @@ -67,6 +67,30 @@ Displays your ignore list @mapinfo [<1-3> [map]] Give information about a map (general info +: 0: no more, 1: players, 2: NPC, 3: shops/chat). +@rates +Displays the server rates. + +@uptime +Show server uptime + +@showdelay +Shows/Hides the "there is a delay after a skill" message. + +@mobinfo / @monsterinfo / @mi +Show Monster info (rates, stats, drops, MVP stuff) + +@iteminfo / @ii +Show Item info (type, price, etc) + +@refresh +Syncs the position of the player on the client with the one stored in the server. + +@time / @date / @server_date / @serverdate / @servertime / @server_time +Gives server time + +@version +Displays SVN Version of the server + @die @@ -400,6 +424,7 @@ Discharges specified character/prisoner All characters are in darkness @day + @option 00 00 00 are used on all characters @doom @@ -450,4 +475,4 @@ Enable a NPC (admin command) Disable a NPC (admin command) @email -to change your e-mail (characters protection) +to change your e-mail (characters protection) \ No newline at end of file diff --git a/doc/item_db.txt b/doc/item_db.txt index 13581d63c..33235187d 100644 --- a/doc/item_db.txt +++ b/doc/item_db.txt @@ -1,125 +1,125 @@ -(FIXME: Someone give this file better formatting) - -- Explanation of the item_db.txt file and structure. - -ID: Item id -JName: Server name to reference the item in scripts and lookups, should use no -spaces. - -Name: Name in english for displaying as output for @ and script commands. - -Type: - 0 Healing item. - 2 Usable item. - 3 Etc item - 4 Weapon - 5 Armor/Garment/Boots/Headgear - 6 Card - 7 Pet egg - 8 Pet equipment - 10 Ammo (Arrows/Bullets/etc) - 11 Usable with delayed consumption (item is lost from inventory after - selecting a target, for use with skills and pet lures) - -Price: Default buying price. When not specified, becomes double the sell price. -Sell: Default buying price. When not specified, becomes half the buy price. - -Weight: Item's weight. Each 10 is 1 weight. - -ATK: Weapon's attack -DEF: Armor's defense -Range: Weapon's attack range -Slot: Amount of slots item possesses. - -Job: Equippable jobs. Uses the following bitmask table: - - (S.) Novice (2^00): 0x00000001 - Swordman (2^01): 0x00000002 - Mage (2^02): 0x00000004 - Archer (2^03): 0x00000008 - Acolyte (2^04): 0x00000010 - Merchant (2^05): 0x00000020 - Thief (2^06): 0x00000040 - Knight (2^07): 0x00000080 - Priest (2^08): 0x00000100 - Wizard (2^09): 0x00000200 - Blacksmith (2^10): 0x00000400 - Hunter (2^11): 0x00000800 - Assassin (2^12): 0x00001000 - Unused (2^13): 0x00002000 - Crusader (2^14): 0x00004000 - Monk (2^15): 0x00008000 - Sage (2^16): 0x00010000 - Rogue (2^17): 0x00020000 - Alchemist (2^18): 0x00040000 - Bard/Dancer (2^19): 0x00080000 - Unused (2^20): 0x00100000 - Taekwon (2^21): 0x00200000 - StarGladi (2^22): 0x00400000 - Soul Linker (2^23): 0x00800000 - Gunslinger (2^24): 0x01000000 - Ninja (2^25): 0x02000000 - -Upper: Equippable upper-types. Uses the following bitmasks: - 1: Normal jobs - 2: Upper jobs - 4: Baby jobs - -Gender: Gender restriction. 0 is female, 1 is male, 2 for both. - -Loc: Equipment's placement. Values are: - - 2^0 001 = Lower Head - 2^9 512 = Middle Head - 2^8 256 = Top head - 2^1 002 = Right hand - 2^5 032 = Left hand - 2^2 004 = mantle - 2^4 016 = armor - 2^6 064 = boots - 2^3 008 = Acc 1 - 2^7 128 = Acc 2 - -wLV: Weapon level. -eLV: Base level required to be able to equip. -Refineable: 1 if the item can be refined, 0 otherwise. - -View: For normal items, defines a replacement view-sprite for the item (eg: - Making apples look like apple juice). The special case are weapons and ammo - where this value indicates the weapon-class of the item. - - For weapons, the types are: - 0: bare fist - 1: Daggers - 2: One-handed swords - 3: Two-handed swords - 4: One-handed spears - 5: Two-handed spears - 6: One-handed axes - 7: Two-handed axes - 8: Maces - 9: Unused - 10: Staves - 11: Bows - 12: Knuckles - 13: Musical Instruments - 14: Whips - 15: Books - 16: Katars - 17: Revolvers - 18: Rifles - 19: Shotguns - 20: Gatling guns - 21: Grenade launchers - 22: Huuma - - For ammo, the types are: - 1: Arrows - 2: Throwable daggers - 3: Bullets - 4: Shells - 5: Grenades - 6: Shurikens - 7: Kunais - -Script: Script to execute when the item is used/equipped. +(FIXME: Someone give this file better formatting) + +- Explanation of the item_db.txt file and structure. + +ID: Item id +JName: Server name to reference the item in scripts and lookups, should use no +spaces. + +Name: Name in english for displaying as output for @ and script commands. + +Type: + 0 Healing item. + 2 Usable item. + 3 Etc item + 4 Weapon + 5 Armor/Garment/Boots/Headgear + 6 Card + 7 Pet egg + 8 Pet equipment + 10 Ammo (Arrows/Bullets/etc) + 11 Usable with delayed consumption (item is lost from inventory after + selecting a target, for use with skills and pet lures) + +Price: Default buying price. When not specified, becomes double the sell price. +Sell: Default buying price. When not specified, becomes half the buy price. + +Weight: Item's weight. Each 10 is 1 weight. + +ATK: Weapon's attack +DEF: Armor's defense +Range: Weapon's attack range +Slot: Amount of slots item possesses. + +Job: Equippable jobs. Uses the following bitmask table: + + (S.) Novice (2^00): 0x00000001 + Swordman (2^01): 0x00000002 + Mage (2^02): 0x00000004 + Archer (2^03): 0x00000008 + Acolyte (2^04): 0x00000010 + Merchant (2^05): 0x00000020 + Thief (2^06): 0x00000040 + Knight (2^07): 0x00000080 + Priest (2^08): 0x00000100 + Wizard (2^09): 0x00000200 + Blacksmith (2^10): 0x00000400 + Hunter (2^11): 0x00000800 + Assassin (2^12): 0x00001000 + Unused (2^13): 0x00002000 + Crusader (2^14): 0x00004000 + Monk (2^15): 0x00008000 + Sage (2^16): 0x00010000 + Rogue (2^17): 0x00020000 + Alchemist (2^18): 0x00040000 + Bard/Dancer (2^19): 0x00080000 + Unused (2^20): 0x00100000 + Taekwon (2^21): 0x00200000 + StarGladi (2^22): 0x00400000 + Soul Linker (2^23): 0x00800000 + Gunslinger (2^24): 0x01000000 + Ninja (2^25): 0x02000000 + +Upper: Equippable upper-types. Uses the following bitmasks: + 1: Normal jobs + 2: Upper jobs + 4: Baby jobs + +Gender: Gender restriction. 0 is female, 1 is male, 2 for both. + +Loc: Equipment's placement. Values are: + + 2^0 001 = Lower Head + 2^9 512 = Middle Head + 2^8 256 = Top head + 2^1 002 = Right hand + 2^5 032 = Left hand + 2^2 004 = mantle + 2^4 016 = armor + 2^6 064 = boots + 2^3 008 = Acc 1 + 2^7 128 = Acc 2 + +wLV: Weapon level. +eLV: Base level required to be able to equip. +Refineable: 1 if the item can be refined, 0 otherwise. + +View: For normal items, defines a replacement view-sprite for the item (eg: + Making apples look like apple juice). The special case are weapons and ammo + where this value indicates the weapon-class of the item. + + For weapons, the types are: + 0: bare fist + 1: Daggers + 2: One-handed swords + 3: Two-handed swords + 4: One-handed spears + 5: Two-handed spears + 6: One-handed axes + 7: Two-handed axes + 8: Maces + 9: Unused + 10: Staves + 11: Bows + 12: Knuckles + 13: Musical Instruments + 14: Whips + 15: Books + 16: Katars + 17: Revolvers + 18: Rifles + 19: Shotguns + 20: Gatling guns + 21: Grenade launchers + 22: Huuma + + For ammo, the types are: + 1: Arrows + 2: Throwable daggers + 3: Bullets + 4: Shells + 5: Grenades + 6: Shurikens + 7: Kunais + +Script: Script to execute when the item is used/equipped. diff --git a/doc/pccommand_list.txt b/doc/pccommand_list.txt index 8aef5a8f5..0fd00db72 100644 --- a/doc/pccommand_list.txt +++ b/doc/pccommand_list.txt @@ -102,4 +102,49 @@ OnPCLoadMapEvent: 1) And as usual... This script runs everytime a player kills a monster It is adviced if you want to repeatedly use this script, to use a sort of filter. +----------------------------------------------------------------------------- + ++ PCCommand: PCDieEvent ++ Code by: Unknown ++ How it works: +When a player dies, the event will be run as if a npc were clicked. The RID of the person killed +will be attached. Simple. It can to be used as a floating npc or as a npc placed on a map. +Notice that this event is server-wide if used as a floating npc, so if you try running it for +more than one map, and want to make a single npc, you'll have to use some sort of filter, which +can be getmapxy, something like this: + +- script PCDieEvent -1,{ +if (getmapxy(@mapname$,@mapx,@mapy,0) == -1) goto L_Finish; +if (@mapname$ == "valkyrie.gat") || (@mapname$ == "amatsu.gat") { +killmonster "valkyrie.gat","All"; +announce "Deep Voice: You have failed.... you have another opportunity though...",bc_self,0x660033; +if (killtest != 0) enablenpc "Outern Voices"; +if (killedonce == 1) end; +set killedonce,1; +} else +end; + +L_Finish: + end; +} + +----or----> + +OnPCDieEvent: +if (getmapxy(@mapname$,@mapx,@mapy,0) == -1) goto L_Finish; +if (@mapname$ == "valkyrie.gat") || (@mapname$ == "amatsu.gat") { +killmonster "valkyrie.gat","All"; +announce "Deep Voice: You have failed.... you have another opportunity though...",bc_self,0x660033; +if (killtest != 0) enablenpc "Outern Voices"; +if (killedonce == 1) end; +set killedonce,1; +} else +end; + +L_Finish: + end; + +We're using getmapxy to obtain the mapname, then adjust our commands and actions depending on the +map. We could also use the command to find if the player died inside a wished area. + ----------------------------------------------------------------------------- \ No newline at end of file diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 0d3ad3b72..4a0458177 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -33,6 +33,10 @@ //= 2.7a - delitem2, countitems2 commands [Lupus] //= 2.7b - clone command [Skotlex] //= 2.7c - disguise / undisguise, query_sql commands [Lupus] + +//= 2.8 - Deleted a copy of the nude command. Added axtoi command (needing a clearer +//= explanation of atoi.Gave a better explanation of OnLabels and modified +//= monster explanation due that L_Label isn't working with monster. //===== Compatible With =================================== //= LOL, can be used by anyone hopefully //===== Description ======================================= @@ -671,6 +675,28 @@ Only the special labels which are not associated with any script command are listed here. There are other kinds of labels which may be triggered in a similar manner, but they are described with their associated commands. +On