From c1dbdcbe3edee8ecdf259ea77f26ae02338a0903 Mon Sep 17 00:00:00 2001 From: Mysteries Date: Sun, 19 May 2013 21:17:12 -0400 Subject: Slight adjustments --- conf/channels.conf | 42 +++++++++++++++++++++++------------------- conf/map-server.conf | 2 +- conf/messages.conf | 16 +++++++++++----- conf/packet.conf | 10 ++++++---- doc/atcommands.txt | 2 +- doc/ea_job_system.txt | 2 +- doc/effect_list.txt | 2 +- doc/item_bonus.txt | 2 +- doc/item_db.txt | 2 +- doc/map_cache.txt | 2 +- doc/md5_hashcheck.txt | 2 +- doc/mob_db_mode_list.txt | 2 +- doc/packet_struct_notation.txt | 2 +- doc/permissions.txt | 2 +- doc/quest_variables.txt | 2 +- doc/script_commands.txt | 2 +- doc/whisper_sys.txt | 2 +- doc/woe_time_explanation.txt | 2 +- src/map/map.h | 34 +++++++++++++++++----------------- src/map/skill.h | 30 +++++++++++++++--------------- 20 files changed, 87 insertions(+), 75 deletions(-) diff --git a/conf/channels.conf b/conf/channels.conf index 3584fc2ea..f17d2aed1 100644 --- a/conf/channels.conf +++ b/conf/channels.conf @@ -8,21 +8,23 @@ //= //= http://hercules.ws/board/ //==================================================== -//= http://hercules.ws/board/topic/316-introducing-hercules-channel-system/ +//================= More Information ================= +// http://hercules.ws/board/topic/316-introducing-hercules-channel-system/ +//==================================================== chsys: ( { - /* default channels (available on boot) */ + /* Default Channels (available on boot) */ default_channels: { /* channel_name : channel_messages_color */ - main: "Orange" /* available as #main */ - support: "Blue" /* available as #support */ - trade: "Red" /* available as #trade */ - offtopic: "Cyan" /* available as #offtopic */ - /* as many channels as you like */ + main: "Orange" /* Available as #main */ + support: "Blue" /* Available as #support */ + trade: "Red" /* Available as #trade */ + offtopic: "Cyan" /* Available as #offtopic */ + /* You may add as many channels as you like */ } - /* colors available */ + /* Colors Available */ colors: { - Default: "0xffffff" /* custom channels will use the first in the list unless a font is selected thru @channel */ + Default: "0xffffff" /* Custom channels use the first color listed unless a font is selected through @channel. */ Red: "0xff0000" Blue: "0x83cfe9" Orange: "0xe57c00" @@ -31,22 +33,25 @@ chsys: ( Green: "0x28bf00" Light_Green: "0x3dff98" Normal: "0x00ff00" - /* as many colors as you like */ + /* As many colors as you like */ } - /* allow users to create their own (private) channels through @channels command? */ + /* Allow users to create their own (private) channels through @channels command? */ /* (must also allow players to use @channels in groups.conf) */ allow_user_channel_creation: true - /* "map_local_channel" is a instanced channel unique to each map */ + + /* "map_local_channel" is a instanced channel unique to each map. */ map_local_channel: true - map_local_channel_name: "map" /* available as #map */ + map_local_channel_name: "map" /* Available as #map */ map_local_channel_color: "Yellow" - map_local_channel_autojoin: true /* can disable autojoin in specific maps through a mapflag or zone */ + map_local_channel_autojoin: true /* You can disable autojoin in specific maps through a mapflag or zone. */ + /* "ally_channel" is a channel shared by all your guild allies */ ally_channel_enabled: true - ally_channel_name: "ally" /* available as #ally */ + ally_channel_name: "ally" /* Available as #ally */ ally_channel_color: "Green" - ally_channel_autojoin: true /* will members autojoin to their respective #ally chats when they log-in? */ - /* "irc_channel" is a special channel connected to a specific chat room in any irc network */ + ally_channel_autojoin: true /* Will members autojoin to their respective #ally chats when they log-in? */ + + /* "irc_channel" is a special channel connected to a specific chat room in any irc network. */ irc_channel_enabled: false irc_channel_name: "irc" /* available as #irc */ irc_channel_color: "Light_Green" @@ -55,5 +60,4 @@ chsys: ( irc_channel_nick: "Hercules_chSysBot" /* nick the bot will use */ irc_channel_nick_pw: "" /* password to this nick (if any) to identify to nick server on the irc network */ } -) - +) \ No newline at end of file diff --git a/conf/map-server.conf b/conf/map-server.conf index d15ef8fa5..446bb0d0e 100644 --- a/conf/map-server.conf +++ b/conf/map-server.conf @@ -1,5 +1,5 @@ //-------------------------------------------------------------- -//Hercules Map-Server Configuration File +// Hercules Map-Server Configuration File //-------------------------------------------------------------- // Note: "Comments" are all text on the right side of a double slash "//" diff --git a/conf/messages.conf b/conf/messages.conf index ac2be835a..e2886a57d 100644 --- a/conf/messages.conf +++ b/conf/messages.conf @@ -1,12 +1,18 @@ -// Hercules messages.conf -// Message Configuration -// For translation, just change msg here (second line), no need to modify source code, -// or alternatively, use conf/import/msg_conf.txt +//===== Hercules Message Configuration ======================= +//= Hercules messages.conf +//===== Description: ========================================= +//= This file handles all messages set throughout the server. +//============================================================ +// For translation, just change msg here (second line), +// no need to modify source code or alternatively, +// use conf/import/msg_conf.txt. +//============================================================ // Format: // // English message // msg_number: translated message +//============================================================ -// 0-410: reserved for GM commands +// 0-410: reserved for GM commands // 500-900 reserved for others // 900-1300: @atcommand diff --git a/conf/packet.conf b/conf/packet.conf index 3528d73bb..85996f4e3 100644 --- a/conf/packet.conf +++ b/conf/packet.conf @@ -1,11 +1,13 @@ -// Hercules Sockets Configuration file -// translated (davidsiaw) - +//===== Hercules Sockets Configuration ======================= +//= Hercules Sockets Configuration File +//===== Translated by: ======================================= +// Davidsiaw +//============================================================ // Display debug reports (When something goes wrong during the report, the report is saved.) debug: no -// How long can a socket stall before closing the connection (in seconds) +// How long can a socket stall before closing the connection (in seconds)? stall_time: 60 // Maximum allowed size for clients packets in bytes (default: 24576). diff --git a/doc/atcommands.txt b/doc/atcommands.txt index b31fe4cef..1e2985f66 100644 --- a/doc/atcommands.txt +++ b/doc/atcommands.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Atcommand List //===== By: ================================================== //= Hercules Dev Team diff --git a/doc/ea_job_system.txt b/doc/ea_job_system.txt index 034b4a617..997debf4d 100644 --- a/doc/ea_job_system.txt +++ b/doc/ea_job_system.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= eAthena Job System //===== By: ================================================== //= Skotlex diff --git a/doc/effect_list.txt b/doc/effect_list.txt index 19b323cc6..01ea2753b 100644 --- a/doc/effect_list.txt +++ b/doc/effect_list.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Client Effects List //===== By: ================================================== //= Hercules Dev Team diff --git a/doc/item_bonus.txt b/doc/item_bonus.txt index 559e49414..fce54b24e 100644 --- a/doc/item_bonus.txt +++ b/doc/item_bonus.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Hercules Item Bonuses List //===== By: ================================================== //= Hercules Dev Team diff --git a/doc/item_db.txt b/doc/item_db.txt index 742a27089..01c9cc011 100644 --- a/doc/item_db.txt +++ b/doc/item_db.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Item Database //===== By: ================================================== //= Hercules Dev Team diff --git a/doc/map_cache.txt b/doc/map_cache.txt index 99e54ef06..19ab92a4d 100644 --- a/doc/map_cache.txt +++ b/doc/map_cache.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Hercules Map Cache Builder and Format Documentation //===== By: ================================================== //= DracoRPG diff --git a/doc/md5_hashcheck.txt b/doc/md5_hashcheck.txt index 12681f367..a2dbf42fa 100644 --- a/doc/md5_hashcheck.txt +++ b/doc/md5_hashcheck.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= MD5 Hash Check //===== By: ================================================== //= Hercules Dev Team diff --git a/doc/mob_db_mode_list.txt b/doc/mob_db_mode_list.txt index f747e38b0..08abf800d 100644 --- a/doc/mob_db_mode_list.txt +++ b/doc/mob_db_mode_list.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Hercules Monster Modes Reference //===== By: ================================================== //= Hercules Dev Team diff --git a/doc/packet_struct_notation.txt b/doc/packet_struct_notation.txt index c1598f3be..0e9c5d055 100644 --- a/doc/packet_struct_notation.txt +++ b/doc/packet_struct_notation.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Packet Structure Notation //===== By: ================================================== //= Ai4rei diff --git a/doc/permissions.txt b/doc/permissions.txt index 1dbfd0056..be51a1821 100644 --- a/doc/permissions.txt +++ b/doc/permissions.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Permission List //===== By: ================================================== //= Hercules Dev Team diff --git a/doc/quest_variables.txt b/doc/quest_variables.txt index 556210dca..0be144183 100644 --- a/doc/quest_variables.txt +++ b/doc/quest_variables.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Permanent Quest Variables //===== By: ================================================== //= Lupus diff --git a/doc/script_commands.txt b/doc/script_commands.txt index a908b338b..269e02745 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= Hercules Script Commands //===== By: ================================================== //= Hercules Dev Team diff --git a/doc/whisper_sys.txt b/doc/whisper_sys.txt index c5c042f4d..3c870b543 100644 --- a/doc/whisper_sys.txt +++ b/doc/whisper_sys.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= NPC Whisper System //===== By: ================================================== //= lordalfa diff --git a/doc/woe_time_explanation.txt b/doc/woe_time_explanation.txt index 2b645118e..9f288eae7 100644 --- a/doc/woe_time_explanation.txt +++ b/doc/woe_time_explanation.txt @@ -1,4 +1,4 @@ -//===== Hercules Documentation ================================ +//===== Hercules Documentation =============================== //= WoE Time Explanation //===== By: ================================================== //= erKURITA diff --git a/src/map/map.h b/src/map/map.h index f524e8840..751cf62f6 100644 --- a/src/map/map.h +++ b/src/map/map.h @@ -32,7 +32,7 @@ enum E_MAPSERVER_ST { #define AREA_SIZE battle_config.area_size #define DAMAGELOG_SIZE 30 #define LOOTITEM_SIZE 10 -#define MAX_MOBSKILL 50 //Max 128, see mob skill_idx type if need this higher +#define MAX_MOBSKILL 50 // Max 128 - See mob skill_idx type if you need this higher. #define MAX_MOB_LIST_PER_MAP 128 #define MAX_EVENTQUEUE 2 #define MAX_EVENTTIMER 32 @@ -63,10 +63,10 @@ enum MOBID { MOBID_MAGICDECOY_WIND = 2046, }; -//The following system marks a different job ID system used by the map server, -//which makes a lot more sense than the normal one. [Skotlex] +// The following system marks a different job ID system used by the map server, +// which makes a lot more sense than the normal one. [Skotlex] // -//These marks the "level" of the job. +// These marks the "level" of the job. #define JOBL_2_1 0x100 //256 #define JOBL_2_2 0x200 //512 #define JOBL_2 0x300 @@ -75,13 +75,13 @@ enum MOBID { #define JOBL_BABY 0x2000 //8192 #define JOBL_THIRD 0x4000 //16384 -//for filtering and quick checking. +// For filtering and quick checking. #define MAPID_BASEMASK 0x00ff #define MAPID_UPPERMASK 0x0fff #define MAPID_THIRDMASK (JOBL_THIRD|MAPID_UPPERMASK) //First Jobs //Note the oddity of the novice: -//Super Novices are considered the 2-1 version of the novice! Novices are considered a first class type, too... +//Super Novices are considered the 2-1 version of the novice! Novices are considered a first class type. enum { //Novice And 1-1 Jobs MAPID_NOVICE = 0x0, @@ -209,31 +209,31 @@ enum { MAPID_BABY_CHASER, }; -//Max size for inputs to Graffiti, Talkie Box and Vending text prompts +// Max size for inputs to Graffiti, Talkie Box and Vending text prompts #define MESSAGE_SIZE (79 + 1) -//String length you can write in the 'talking box' +// String length you can write in the 'talking box' #define CHATBOX_SIZE (70 + 1) -//Chatroom-related string sizes +// Chatroom-related string sizes #define CHATROOM_TITLE_SIZE (36 + 1) #define CHATROOM_PASS_SIZE (8 + 1) -//Max allowed chat text length +// Max allowed chat text length #define CHAT_SIZE_MAX (255 + 1) -//24 for npc name + 24 for label + 2 for a "::" and 1 for EOS +// 24 for npc name + 24 for label + 2 for a "::" and 1 for EOS #define EVENT_NAME_LENGTH ( NAME_LENGTH * 2 + 3 ) #define DEFAULT_AUTOSAVE_INTERVAL 5*60*1000 -//Specifies maps where players may hit each other +// Specifies maps where players may hit each other #define map_flag_vs(m) (map[m].flag.pvp || map[m].flag.gvg_dungeon || map[m].flag.gvg || ((agit_flag || agit2_flag) && map[m].flag.gvg_castle) || map[m].flag.battleground) -//Specifies maps that have special GvG/WoE restrictions +// Specifies maps that have special GvG/WoE restrictions #define map_flag_gvg(m) (map[m].flag.gvg || ((agit_flag || agit2_flag) && map[m].flag.gvg_castle)) -//Specifies if the map is tagged as GvG/WoE (regardless of agit_flag status) +// Specifies if the map is tagged as GvG/WoE (regardless of agit_flag status) #define map_flag_gvg2(m) (map[m].flag.gvg || map[m].flag.gvg_castle) // No Kill Steal Protection #define map_flag_ks(m) (map[m].flag.town || map[m].flag.pvp || map[m].flag.gvg || map[m].flag.battleground) -//This stackable implementation does not means a BL can be more than one type at a time, but it's -//meant to make it easier to check for multiple types at a time on invocations such as map_foreach* calls [Skotlex] +//This stackable implementation does not mean a BL can be more than one type at a time, but it's +// meant to make it easier to check for multiple types at a time on invocations such as map_foreach* calls. [Skotlex] enum bl_type { BL_NUL = 0x000, BL_PC = 0x001, @@ -250,7 +250,7 @@ enum bl_type { BL_ALL = 0xFFF, }; -//For common mapforeach calls. Since pets cannot be affected, they aren't included here yet. +// For common mapforeach calls. Since pets cannot be affected, they aren't included here yet. #define BL_CHAR (BL_PC|BL_MOB|BL_HOM|BL_MER|BL_ELEM) enum npc_subtype { WARP, SHOP, SCRIPT, CASHSHOP, TOMB }; diff --git a/src/map/skill.h b/src/map/skill.h index 553dabd6d..c585bbb3a 100644 --- a/src/map/skill.h +++ b/src/map/skill.h @@ -81,14 +81,14 @@ enum e_skill_nk { //Constants to identify a skill's inf2 value. enum e_skill_inf2 { INF2_QUEST_SKILL = 0x0001, - INF2_NPC_SKILL = 0x0002, //NPC skills are those that players can't have in their skill tree. + INF2_NPC_SKILL = 0x0002, // NPC skills are those that players can't have in their skill tree. INF2_WEDDING_SKILL = 0x0004, INF2_SPIRIT_SKILL = 0x0008, INF2_GUILD_SKILL = 0x0010, INF2_SONG_DANCE = 0x0020, INF2_ENSEMBLE_SKILL = 0x0040, INF2_TRAP = 0x0080, - INF2_TARGET_SELF = 0x0100, //Refers to ground placed skills that will target the caster as well (like Grandcross) + INF2_TARGET_SELF = 0x0100, // Refers to ground placed skills that will target the caster as well (like Grandcross) INF2_NO_TARGET_SELF = 0x0200, INF2_PARTY_ONLY = 0x0400, INF2_GUILD_ONLY = 0x0800, @@ -107,19 +107,19 @@ enum e_skill_display { }; enum { - UF_DEFNOTENEMY = 0x0001, // If 'defunit_not_enemy' is set, the target is changed to 'friend' - UF_NOREITERATION = 0x0002, // Spell cannot be stacked - UF_NOFOOTSET = 0x0004, // Spell cannot be cast near/on targets - UF_NOOVERLAP = 0x0008, // Spell effects do not overlap - UF_PATHCHECK = 0x0010, // Only cells with a shootable path will be placed - UF_NOPC = 0x0020, // May not target players - UF_NOMOB = 0x0040, // May not target mobs - UF_SKILL = 0x0080, // May target skills - UF_DANCE = 0x0100, // Dance - UF_ENSEMBLE = 0x0200, // Duet - UF_SONG = 0x0400, // Song - UF_DUALMODE = 0x0800, // Spells should trigger both ontimer and onplace/onout/onleft effects. - UF_RANGEDSINGLEUNIT = 0x2000 // hack for ranged layout, only display center + UF_DEFNOTENEMY = 0x0001, // If 'defunit_not_enemy' is set, the target is changed to 'friend' + UF_NOREITERATION = 0x0002, // Spell cannot be stacked + UF_NOFOOTSET = 0x0004, // Spell cannot be cast near/on targets + UF_NOOVERLAP = 0x0008, // Spell effects do not overlap + UF_PATHCHECK = 0x0010, // Only cells with a shootable path will be placed + UF_NOPC = 0x0020, // May not target players + UF_NOMOB = 0x0040, // May not target mobs + UF_SKILL = 0x0080, // May target skills + UF_DANCE = 0x0100, // Dance + UF_ENSEMBLE = 0x0200, // Duet + UF_SONG = 0x0400, // Song + UF_DUALMODE = 0x0800, // Spells should trigger both ontimer and onplace/onout/onleft effects. + UF_RANGEDSINGLEUNIT = 0x2000 // Hack for ranged layout, only display center }; //Returns the cast type of the skill: ground cast, castend damage, castend no damage -- cgit v1.2.3-70-g09d2