diff --git a/common/ruletypes.h b/common/ruletypes.h index f4ca7c2d9..f9b46cda1 100644 --- a/common/ruletypes.h +++ b/common/ruletypes.h @@ -36,98 +36,98 @@ RULE_CATEGORY(Character) -RULE_INT(Character, MaxLevel, 65, "") -RULE_BOOL(Character, PerCharacterQglobalMaxLevel, false, "This will check for qglobal 'CharMaxLevel' character qglobal (Type 5, \"\"), if player tries to level beyond that point, it will not go beyond that level") -RULE_BOOL(Character, PerCharacterBucketMaxLevel, false, "This will check for data bucket 'CharMaxLevel', if player tries to level beyond that point, it will not go beyond that level") -RULE_INT(Character, MaxExpLevel, 0, "Sets the Max Level attainable via Experience") -RULE_INT(Character, DeathExpLossLevel, 10, "Any level greater than this will lose exp on death") -RULE_INT(Character, DeathExpLossMaxLevel, 255, "Any level greater than this will no longer lose exp on death") -RULE_INT(Character, DeathItemLossLevel, 10, "") -RULE_INT(Character, DeathExpLossMultiplier, 3, "Adjust how much exp is lost") -RULE_BOOL(Character, UseDeathExpLossMult, false, "Adjust to use the above multiplier or to use code default") -RULE_BOOL(Character, UseOldRaceRezEffects, false, "older clients had ID 757 for races with high starting STR, but it doesn't seem used anymore") -RULE_INT(Character, CorpseDecayTimeMS, 10800000, "") -RULE_INT(Character, CorpseResTimeMS, 10800000, "time before cant res corpse(3 hours)") -RULE_BOOL(Character, LeaveCorpses, true, "") -RULE_BOOL(Character, LeaveNakedCorpses, false, "") -RULE_INT(Character, MaxDraggedCorpses, 2, "") -RULE_REAL(Character, DragCorpseDistance, 400, "If the corpse is <= this distance from the player, it won't move") -RULE_REAL(Character, ExpMultiplier, 0.5, "") -RULE_REAL(Character, AAExpMultiplier, 0.5, "") -RULE_REAL(Character, GroupExpMultiplier, 0.5, "") -RULE_REAL(Character, RaidExpMultiplier, 0.2, "") -RULE_BOOL(Character, UseXPConScaling, true, "") -RULE_INT(Character, ShowExpValues, 0, "0 - normal, 1 - Show raw experience values, 2 - Show raw experience values AND percent") -RULE_INT(Character, GreenModifier, 20, "") -RULE_INT(Character, LightBlueModifier, 40, "") -RULE_INT(Character, BlueModifier, 90, "") -RULE_INT(Character, WhiteModifier, 100, "") -RULE_INT(Character, YellowModifier, 125, "") -RULE_INT(Character, RedModifier, 150, "") -RULE_INT(Character, AutosaveIntervalS, 300, "0 = disabled") -RULE_INT(Character, HPRegenMultiplier, 100, "") -RULE_INT(Character, ManaRegenMultiplier, 100, "") -RULE_INT(Character, EnduranceRegenMultiplier, 100, "") -RULE_BOOL(Character, OldMinMana, false, "this is used for servers that want to follow older skill cap formulas so they can still have some regen w/o mediate") -RULE_INT(Character, ConsumptionMultiplier, 100, "item's hunger restored = this value * item's food level, 100 = normal, 50 = people eat 2x as fast, 200 = people eat 2x as slow") -RULE_BOOL(Character, HealOnLevel, false, "") -RULE_BOOL(Character, FeignKillsPet, false, "") -RULE_INT(Character, ItemManaRegenCap, 15, "") -RULE_INT(Character, ItemHealthRegenCap, 30, "") -RULE_INT(Character, ItemDamageShieldCap, 30, "") -RULE_INT(Character, ItemAccuracyCap, 150, "") -RULE_INT(Character, ItemAvoidanceCap, 100, "") -RULE_INT(Character, ItemCombatEffectsCap, 100, "") -RULE_INT(Character, ItemShieldingCap, 35, "") -RULE_INT(Character, ItemSpellShieldingCap, 35, "") -RULE_INT(Character, ItemDoTShieldingCap, 35, "") -RULE_INT(Character, ItemStunResistCap, 35, "") -RULE_INT(Character, ItemStrikethroughCap, 35, "") -RULE_INT(Character, ItemATKCap, 250, "") -RULE_INT(Character, ItemHealAmtCap, 250, "") -RULE_INT(Character, ItemSpellDmgCap, 250, "") -RULE_INT(Character, ItemClairvoyanceCap, 250, "") -RULE_INT(Character, ItemDSMitigationCap, 50, "") -RULE_INT(Character, ItemEnduranceRegenCap, 15, "") -RULE_INT(Character, ItemExtraDmgCap, 150, "Cap for bonuses to melee skills like Bash, Frenzy, etc") +RULE_INT(Character, MaxLevel, 65, "Sets the highest level attainable by experience for players") +RULE_BOOL(Character, PerCharacterQglobalMaxLevel, false, "Check for qglobal 'CharMaxLevel' character qglobal (Type 5, \"\"), if player tries to level beyond that point, it will not go beyond that level") +RULE_BOOL(Character, PerCharacterBucketMaxLevel, false, "Check for data bucket 'CharMaxLevel', if player tries to level beyond that point, it will not go beyond that level") +RULE_INT(Character, MaxExpLevel, 0, "Defines the maximum level that can be reached through experience") +RULE_INT(Character, DeathExpLossLevel, 10, "Any level equal to or greater than this will lose experience at death") +RULE_INT(Character, DeathExpLossMaxLevel, 255, "Every higher level will no longer lose experience at death") +RULE_INT(Character, DeathItemLossLevel, 10, "From this level on, items are left in the corpse when LeaveCorpses is activated") +RULE_INT(Character, DeathExpLossMultiplier, 3, "Adjust how much experience is lost. Default 3.5% (0=0.5%, 1=1.5%, 2=2.5%, 3=3.5%, 4=4.5%, 5=5.5%, 6=6.5%, 7=7.5%, 8=8.5%, 9=9.5%, 10=11%)") +RULE_BOOL(Character, UseDeathExpLossMult, false, "Setting to control whether DeathExpLossMultiplier or the code default is used: (Level x Level / 18.0) x 12000") +RULE_BOOL(Character, UseOldRaceRezEffects, false, "Older clients had ID 757 for races with high starting STR, but it doesn't seem used anymore") +RULE_INT(Character, CorpseDecayTimeMS, 10800000, "Time after which the corpse decays (milliseconds)") +RULE_INT(Character, CorpseResTimeMS, 10800000, "Time after which the corpse can no longer be resurrected (milliseconds)") +RULE_BOOL(Character, LeaveCorpses, true, "Setting whether you leave a corpse behind") +RULE_BOOL(Character, LeaveNakedCorpses, false, "Setting whether you leave a corpse without items") +RULE_INT(Character, MaxDraggedCorpses, 2, "Maximum number of corpses you can drag at once") +RULE_REAL(Character, DragCorpseDistance, 400, "If a player is using /corpsedrag and moving, the corpse will not move until the player exceeds this distance") +RULE_REAL(Character, ExpMultiplier, 0.5, "If greater than 0, the experience gained is multiplied by this value. ") +RULE_REAL(Character, AAExpMultiplier, 0.5, "If greater than 0, the AA experience gained is multiplied by this value. ") +RULE_REAL(Character, GroupExpMultiplier, 0.5, "The experience in a group is multiplied by this value in addition to the group multiplier. The group multiplier is: 2 members=x 1.2, 3=x1.4, 4=x1.6, 5=x1.8, 6=x2.16") +RULE_REAL(Character, RaidExpMultiplier, 0.2, "The experience gained in raids is multiplied by (1-RaidExpMultiplier) ") +RULE_BOOL(Character, UseXPConScaling, true, "When activated, the experience is modified depending on the difference between player level and NPC level. The settings Green/LightBlue/Blue//White/Yellow and RedModifier are used") +RULE_INT(Character, ShowExpValues, 0, "Show expirience values. 0=normal, 1=show raw experience values, 2=show raw experience values and percent") +RULE_INT(Character, GreenModifier, 20, "The experience obtained for green con mobs is multiplied by value/100") +RULE_INT(Character, LightBlueModifier, 40, "The experience obtained for light-blue con mobs is multiplied by value/100") +RULE_INT(Character, BlueModifier, 90, "The experience obtained for blue con mobs is multiplied by value/100") +RULE_INT(Character, WhiteModifier, 100, "The experience obtained for white con mobs is multiplied by value/100") +RULE_INT(Character, YellowModifier, 125, "The experience obtained for yellow con mobs is multiplied by value/100") +RULE_INT(Character, RedModifier, 150, "The experience obtained for red con mobs is multiplied by value/100") +RULE_INT(Character, AutosaveIntervalS, 300, "Number of seconds after which a timer is triggered which stores the character data. The value 0 means no periodic automatic saving.") +RULE_INT(Character, HPRegenMultiplier, 100, "The hitpoint regeneration is multiplied by value/100 (up to the caps)") +RULE_INT(Character, ManaRegenMultiplier, 100, "The mana regeneration is multiplied by value/100 (up to the caps)") +RULE_INT(Character, EnduranceRegenMultiplier, 100, "The endurance regeneration is multiplied by value/100 (up to the caps)") +RULE_BOOL(Character, OldMinMana, false, "This is used for servers that want to follow older skill cap formulas so they can still have some regen w/o mediate") +RULE_INT(Character, ConsumptionMultiplier, 100, "Item's hunger restored = value x item's food level. 100=normal, 50=player eat 2x as fast, 200=player eat 2x as slow") +RULE_BOOL(Character, HealOnLevel, false, "Setting whether a player should heal completely when leveling") +RULE_BOOL(Character, FeignKillsPet, false, "Setting whether Feign Death kills the player pet") +RULE_INT(Character, ItemManaRegenCap, 15, "Limit on mana regeneration granted by items") +RULE_INT(Character, ItemHealthRegenCap, 30, "Limit on health regeneration granted by items") +RULE_INT(Character, ItemDamageShieldCap, 30, "Limit on damage shields granted by items") +RULE_INT(Character, ItemAccuracyCap, 150, "Limit on accuracy granted by items") +RULE_INT(Character, ItemAvoidanceCap, 100, "Limit on avoidance granted by items") +RULE_INT(Character, ItemCombatEffectsCap, 100, "Limit on combat effects granted by items") +RULE_INT(Character, ItemShieldingCap, 35, "Limit on shielding granted by items") +RULE_INT(Character, ItemSpellShieldingCap, 35, "Limit on spell shieldung granted by items") +RULE_INT(Character, ItemDoTShieldingCap, 35, "Limit on DoT shielding granted by items") +RULE_INT(Character, ItemStunResistCap, 35, "Limit on resistance granted by items") +RULE_INT(Character, ItemStrikethroughCap, 35, "Limit on strikethrough granted by items") +RULE_INT(Character, ItemATKCap, 250, "Limit on ATK granted by items") +RULE_INT(Character, ItemHealAmtCap, 250, "Limit on heal amount granted by items") +RULE_INT(Character, ItemSpellDmgCap, 250, "Limit on spell damage granted by items") +RULE_INT(Character, ItemClairvoyanceCap, 250, "Limit on clairvoyance granted by items") +RULE_INT(Character, ItemDSMitigationCap, 50, "Limit on damageshield mitigation granted by items") +RULE_INT(Character, ItemEnduranceRegenCap, 15, "Limit on endurance regeneration granted by items") +RULE_INT(Character, ItemExtraDmgCap, 150, "Cap for bonuses to melee skills like Bash, Frenzy, etc.") RULE_INT(Character, HasteCap, 100, "Haste cap for non-v3(overhaste) haste") -RULE_INT(Character, SkillUpModifier, 100, "skill ups are at 100%") -RULE_BOOL(Character, SharedBankPlat, false, "off by default to prevent duping for now") -RULE_BOOL(Character, BindAnywhere, false, "") -RULE_BOOL(Character, RestRegenEnabled, true, "Enable OOC Regen") +RULE_INT(Character, SkillUpModifier, 100, "The probability for a skill-up is multiplied by value/100") +RULE_BOOL(Character, SharedBankPlat, false, "Shared bank platinum. Off by default to prevent duplication") +RULE_BOOL(Character, BindAnywhere, false, "Allows players to bind their soul anywhere in the world") +RULE_BOOL(Character, RestRegenEnabled, true, "Setting to activate out-of-combat regeneration") RULE_INT(Character, RestRegenTimeToActivate, 30, "Time in seconds for rest state regen to kick in") RULE_INT(Character, RestRegenRaidTimeToActivate, 300, "Time in seconds for rest state regen to kick in with a raid target") -RULE_INT(Character, KillsPerGroupLeadershipAA, 250, "Number of dark blues or above per Group Leadership AA") -RULE_INT(Character, KillsPerRaidLeadershipAA, 250, "Number of dark blues or above per Raid Leadership AA") -RULE_INT(Character, MaxFearDurationForPlayerCharacter, 4, "4 tics, each tic calculates every 6 seconds") -RULE_INT(Character, MaxCharmDurationForPlayerCharacter, 15, "") -RULE_INT(Character, BaseHPRegenBonusRaces, 4352, "a bitmask of race(s) that receive the regen bonus. Iksar (4096) & Troll (256) = 4352. see common/races.h for the bitmask values") +RULE_INT(Character, KillsPerGroupLeadershipAA, 250, "Minimum number of dark blue mobs that must be killed to get a Group Leadership AA") +RULE_INT(Character, KillsPerRaidLeadershipAA, 250, "Minimum number of dark blue mobs that must be killed to get a Raid Leadership AAA") +RULE_INT(Character, MaxFearDurationForPlayerCharacter, 4, "Maximum number of tics a player can be feared. 1 tic equls 6 seconds") +RULE_INT(Character, MaxCharmDurationForPlayerCharacter, 15, "Maximum number of tics a player can be charmed. 1 tic equls 6 seconds") +RULE_INT(Character, BaseHPRegenBonusRaces, 4352, "A bitmask of race(s) that receive the regen bonus. Iksar (4096) & Troll (256) = 4352. See common/races.h for the bitmask values") RULE_BOOL(Character, SoDClientUseSoDHPManaEnd, false, "Setting this to true will allow SoD clients to use the SoD HP/Mana/End formulas and previous clients will use the old formulas") RULE_BOOL(Character, UseRaceClassExpBonuses, true, "Setting this to true will enable Class and Racial experience rate bonuses") -RULE_BOOL(Character, UseOldRaceExpPenalties, false, "Setting this to true will enable racial exp penalties for Iksar, Troll, Ogre, and Barbarian, as well as the bonus for Halflings") -RULE_BOOL(Character, UseOldClassExpPenalties, false, "Setting this to true will enable old class exp penalties for Paladin, SK, Ranger, Bard, Monk, Wizard, Enchanter, Magician, and Necromancer, as well as the bonus for Rogues and Warriors") -RULE_BOOL(Character, RespawnFromHover, false, "Use Respawn window, or not") -RULE_INT(Character, RespawnFromHoverTimer, 300, "Respawn Window countdown timer, in SECONDS") -RULE_BOOL(Character, UseNewStatsWindow, true, "New stats window shows everything") -RULE_BOOL(Character, ItemCastsUseFocus, false, "If true, this allows item clickies to use focuses that have limited max levels on them") +RULE_BOOL(Character, UseOldRaceExpPenalties, false, "Setting this to true will enable racial experience penalties for Iksar, Troll, Ogre, and Barbarian, as well as the bonus for Halflings") +RULE_BOOL(Character, UseOldClassExpPenalties, false, "Setting this to true will enable old class experience penalties for Paladin, SK, Ranger, Bard, Monk, Wizard, Enchanter, Magician, and Necromancer, as well as the bonus for Rogues and Warriors") +RULE_BOOL(Character, RespawnFromHover, false, "Setting whether the respawn window should be used") +RULE_INT(Character, RespawnFromHoverTimer, 300, "Respawn Window countdown timer, in seconds") +RULE_BOOL(Character, UseNewStatsWindow, true, "Setting whether the new Stats window, which displays all information, should be used") +RULE_BOOL(Character, ItemCastsUseFocus, false, "If true, this allows item clickies to use focuses that have limited maximum levels on them") RULE_INT(Character, MinStatusForNoDropExemptions, 80, "This allows status x and higher to trade no drop items") -RULE_INT(Character, SkillCapMaxLevel, 75, "Sets the Max Level used for Skill Caps (from skill_caps table). -1 makes it use MaxLevel rule value. It is set to 75 because PEQ only has skillcaps up to that level, and grabbing the players' skill past 75 will return 0, breaking all skills past that level. This helps servers with obsurd level caps (75+ level cap) function without any modifications") -RULE_INT(Character, StatCap, 0, "") +RULE_INT(Character, SkillCapMaxLevel, 75, "Sets the Maximum Level used for Skill Caps (from skill_caps table). -1 makes it use MaxLevel rule value. It is set to 75 because PEQ only has skillcaps up to that level, and grabbing the players' skill past 75 will return 0, breaking all skills past that level. This helps servers with obsurd level caps (75+ level cap) function without any modifications") +RULE_INT(Character, StatCap, 0, "If StatCap > 0 then this value is used. If it is 0, the value of the following code is used: If Level < 61: 255. If Level >= 61 and the client SoF or newer: 255 + 5 x (level -60). If the client is older than SoF and the level < 71 then: 255 + x (level-60). In all other cases: 330.") RULE_BOOL(Character, CheckCursorEmptyWhenLooting, true, "If true, a player cannot loot a corpse (player or NPC) with an item on their cursor") RULE_BOOL(Character, MaintainIntoxicationAcrossZones, true, "If true, alcohol effects are maintained across zoning and logging out/in") RULE_BOOL(Character, EnableDiscoveredItems, true, "If enabled, it enables EVENT_DISCOVER_ITEM and also saves character names and timestamps for the first time an item is discovered") -RULE_BOOL(Character, EnableXTargetting, true, "Enable Extended Targetting Window, for users with UF and later clients") +RULE_BOOL(Character, EnableXTargetting, true, "Enable Extended Targeting Window, for users with UF and later clients") RULE_BOOL(Character, EnableAggroMeter, true, "Enable Aggro Meter, for users with RoF and later clients") RULE_BOOL(Character, KeepLevelOverMax, false, "Don't delevel a character that has somehow gone over the level cap") RULE_INT(Character, FoodLossPerUpdate, 32, "How much food/water you lose per stamina update") -RULE_BOOL(Character, EnableHungerPenalties, false, "being hungry/thirsty has negative effects -- it does appear normal live servers do not have penalties") -RULE_BOOL(Character, EnableFoodRequirement, true, "if disabled, food is no longer required") -RULE_INT(Character, BaseInstrumentSoftCap, 36, "Softcap for instrument mods, 36 commonly referred to as \"3.6\" as well") +RULE_BOOL(Character, EnableHungerPenalties, false, "Being hungry/thirsty has negative effects -- it does appear normal live servers do not have penalties") +RULE_BOOL(Character, EnableFoodRequirement, true, "If disabled, food is no longer required") +RULE_INT(Character, BaseInstrumentSoftCap, 36, "Softcap for instrument mods, 36 commonly referred to as 3.6 as well") RULE_BOOL(Character, UseSpellFileSongCap, true, "When they removed the AA that increased the cap they removed the above and just use the spell field") RULE_INT(Character, BaseRunSpeedCap, 158, "Base Run Speed Cap, on live it's 158% which will give you a runspeed of 1.580 hard capped to 225") RULE_INT(Character, OrnamentationAugmentType, 20, "Ornamentation Augment Type") -RULE_REAL(Character, EnvironmentDamageMulipliter, 1, "") -RULE_BOOL(Character, UnmemSpellsOnDeath, true, "") +RULE_REAL(Character, EnvironmentDamageMulipliter, 1, "Multiplier for environmental damage like fall damage.") +RULE_BOOL(Character, UnmemSpellsOnDeath, true, "Setting whether at death all memorized Spells are forgotten") RULE_INT(Character, TradeskillUpAlchemy, 2, "Alchemy skillup rate adjust. Lower is faster") RULE_INT(Character, TradeskillUpBaking, 2, "Baking skillup rate adjust. Lower is faster") RULE_INT(Character, TradeskillUpBlacksmithing, 2, "Blacksmithing skillup rate adjust. Lower is faster") @@ -138,25 +138,25 @@ RULE_INT(Character, TradeskillUpMakePoison, 2, "Make Poison skillup rate adjust. RULE_INT(Character, TradeskillUpPottery, 4, "Pottery skillup rate adjust. Lower is faster") RULE_INT(Character, TradeskillUpResearch, 1, "Research skillup rate adjust. Lower is faster") RULE_INT(Character, TradeskillUpTinkering, 2, "Tinkering skillup rate adjust. Lower is faster") -RULE_BOOL(Character, MarqueeHPUpdates, false, "Will show Health % in center of screen < 100%") -RULE_INT(Character, IksarCommonTongue, 95, "95 By default (live-like?)") -RULE_INT(Character, OgreCommonTongue, 95, "95 By default (live-like?)") -RULE_INT(Character, TrollCommonTongue, 95, "95 By default (live-like?)") +RULE_BOOL(Character, MarqueeHPUpdates, false, "Will show health percentage in center of screen if health lesser than 100%") +RULE_INT(Character, IksarCommonTongue, 95, "Starting value for Common Tongue for Iksars") +RULE_INT(Character, OgreCommonTongue, 95, "Starting value for Common Tongue for Ogres") +RULE_INT(Character, TrollCommonTongue, 95, "Starting value for Common Tongue for Trolls") RULE_BOOL(Character, ActiveInvSnapshots, false, "Takes a periodic snapshot of inventory contents from online players") -RULE_INT(Character, InvSnapshotMinIntervalM, 180, "Minimum time (in minutes) between inventory snapshots") -RULE_INT(Character, InvSnapshotMinRetryM, 30, "Time (in minutes) to re-attempt an inventory snapshot after a failure") -RULE_INT(Character, InvSnapshotHistoryD, 30, "Time (in days) to keep snapshot entries") -RULE_BOOL(Character, RestrictSpellScribing, false, "Restricts spell scribing to allowable races/classes of spell scroll, if true") +RULE_INT(Character, InvSnapshotMinIntervalM, 180, "Minimum time between inventory snapshots (minutes)") +RULE_INT(Character, InvSnapshotMinRetryM, 30, "Time to re-attempt an inventory snapshot after a failure (minutes)") +RULE_INT(Character, InvSnapshotHistoryD, 30, "Time to keep snapshot entries (days)") +RULE_BOOL(Character, RestrictSpellScribing, false, "Setting whether to testricts spell scribing to allowable races/classes of spell scroll") RULE_BOOL(Character, UseStackablePickPocketing, true, "Allows stackable pickpocketed items to stack instead of only being allowed in empty inventory slots") -RULE_BOOL(Character, EnableAvoidanceCap, false, "") +RULE_BOOL(Character, EnableAvoidanceCap, false, "Setting whether the avoidance cap should be activated") RULE_INT(Character, AvoidanceCap, 750, "750 Is a pretty good value, seen people dodge all attacks beyond 1,000 Avoidance") RULE_BOOL(Character, AllowMQTarget, false, "Disables putting players in the 'hackers' list for targeting beyond the clip plane or attempting to target something untargetable") RULE_BOOL(Character, UseOldBindWound, false, "Uses the original bind wound behavior") RULE_BOOL(Character, GrantHoTTOnCreate, false, "Grant Health of Target's Target leadership AA on character creation") -RULE_BOOL(Character, UseOldConSystem, false, "Grant Health of Target's Target leadership AA on character creation") +RULE_BOOL(Character, UseOldConSystem, false, "Setting whether the pre SoF era consider system should be used") RULE_BOOL(Character, OPClientUpdateVisualDebug, false, "Shows a pulse and forward directional particle each time the client sends its position to server") -RULE_BOOL(Character, AllowCrossClassTrainers, false, "") -RULE_BOOL(Character, PetsUseReagents, true, "Pets use reagent on spells") +RULE_BOOL(Character, AllowCrossClassTrainers, false, "If the value is true, a player can also train with other class Guildmasters.") +RULE_BOOL(Character, PetsUseReagents, true, "Conjuring pets consumes reagents") RULE_BOOL(Character, DismountWater, true, "Dismount horses when entering water") RULE_BOOL(Character, UseNoJunkFishing, false, "Disregards junk items when fishing") RULE_BOOL(Character, SoftDeletes, true, "When characters are deleted in character select, they are only soft deleted") @@ -165,94 +165,92 @@ RULE_BOOL(Character, ProcessFearedProximity, false, "Processes proximity checks RULE_CATEGORY_END() RULE_CATEGORY(Mercs) -RULE_INT(Mercs, SuspendIntervalMS, 10000, "") -RULE_INT(Mercs, UpkeepIntervalMS, 180000, "") -RULE_INT(Mercs, SuspendIntervalS, 10, "") -RULE_INT(Mercs, UpkeepIntervalS, 180, "") -RULE_BOOL(Mercs, AllowMercs, false, "") -RULE_BOOL(Mercs, ChargeMercPurchaseCost, false, "") -RULE_BOOL(Mercs, ChargeMercUpkeepCost, false, "") +RULE_INT(Mercs, SuspendIntervalMS, 10000, "Time interval for merc suspend (milliseconds)") +RULE_INT(Mercs, UpkeepIntervalMS, 180000, "Time interval for merc upkeep (milliseconds)") +RULE_INT(Mercs, SuspendIntervalS, 10, "Time interval for merc suspend command (seconds)") +RULE_BOOL(Mercs, AllowMercs, false, "Allow the use of mercs") +RULE_BOOL(Mercs, ChargeMercPurchaseCost, false, "Turns Mercenary purchase costs on or off") +RULE_BOOL(Mercs, ChargeMercUpkeepCost, false, "Turns Mercenary upkeep costs on or off") RULE_INT(Mercs, AggroRadius, 100, "Determines the distance from which a merc will aggro group member's target(also used to determine the distance at which a healer merc will begin healing a group member)") RULE_INT(Mercs, AggroRadiusPuller, 25, "Determines the distance from which a merc will aggro group member's target, if they have the group role of puller (also used to determine the distance at which a healer merc will begin healing a group member, if they have the group role of puller)") RULE_INT(Mercs, ResurrectRadius, 50, "Determines the distance from which a healer merc will attempt to resurrect a group member's corpse") -RULE_INT(Mercs, ScaleRate, 100, "") +RULE_INT(Mercs, ScaleRate, 100, "Merc scale factor") RULE_BOOL(Mercs, MercsUsePathing, true, "Mercs will use node pathing when moving") -RULE_BOOL(Mercs, AllowMercSuspendInCombat, true, "") +RULE_BOOL(Mercs, AllowMercSuspendInCombat, true, "Allow merc suspend in combat") RULE_CATEGORY_END() RULE_CATEGORY(Guild) -RULE_INT(Guild, MaxMembers, 2048, "") +RULE_INT(Guild, MaxMembers, 2048, "Maximum number of members a guild can have") RULE_BOOL(Guild, PlayerCreationAllowed, false, "Allow players to create a guild using the window in Underfoot+") RULE_INT(Guild, PlayerCreationLimit, 1, "Only allow use of the UF+ window if the account has < than this number of guild leaders on it") -RULE_INT(Guild, PlayerCreationRequiredStatus, 0, "Required admin status") -RULE_INT(Guild, PlayerCreationRequiredLevel, 0, "Required Level of the player attempting to create the guild") -RULE_INT(Guild, PlayerCreationRequiredTime, 0, "Required Time Entitled On Account (in Minutes) to create the guild") +RULE_INT(Guild, PlayerCreationRequiredStatus, 0, "Required status to create a guild") +RULE_INT(Guild, PlayerCreationRequiredLevel, 0, "Required level of the player attempting to create the guild") +RULE_INT(Guild, PlayerCreationRequiredTime, 0, "Time needed online on the account to create a guild (in minutes)") RULE_CATEGORY_END() RULE_CATEGORY(Skills) -RULE_INT(Skills, MaxTrainTradeskills, 21, "") -RULE_BOOL(Skills, UseLimitTradeskillSearchSkillDiff, true, "") -RULE_INT(Skills, MaxTradeskillSearchSkillDiff, 50, "") -RULE_INT(Skills, MaxTrainSpecializations, 50, "Max level a GM trainer will train casting specializations") -RULE_INT(Skills, SwimmingStartValue, 100, "") -RULE_BOOL(Skills, TrainSenseHeading, false, "") -RULE_INT(Skills, SenseHeadingStartValue, 200, "") -RULE_BOOL(Skills, SelfLanguageLearning, true, "") -RULE_BOOL(Skills, RequireTomeHandin, false, "Disable click-to-learn and force turnin to Guild Master") +RULE_INT(Skills, MaxTrainTradeskills, 21, "Highest level for trading skills that can be learnt by the trainer") +RULE_BOOL(Skills, UseLimitTradeskillSearchSkillDiff, true, "Enables the limit for the maximum difference between trivial and skill for recipe searches and favorites") +RULE_INT(Skills, MaxTradeskillSearchSkillDiff, 50, "The maximum difference in skill between the trivial of an item and the skill of the player if the trivial is higher than the skill. Recipes that have not been learnt or made at least once via the Experiment mode will be removed from searches based on this criteria.") +RULE_INT(Skills, MaxTrainSpecializations, 50, "Maximum level a GM trainer will train casting specializations") +RULE_INT(Skills, SwimmingStartValue, 100, "Start value of swimming skill") +RULE_BOOL(Skills, TrainSenseHeading, false, "Switch whether SenseHeading is trained by use") +RULE_INT(Skills, SenseHeadingStartValue, 200, "Start value of sense heading skill") +RULE_BOOL(Skills, SelfLanguageLearning, true, "Enabling self learning of languages") +RULE_BOOL(Skills, RequireTomeHandin, false, "Disable click-to-learn and force hand in to Guild Master") RULE_CATEGORY_END() RULE_CATEGORY(Pets) -RULE_REAL(Pets, AttackCommandRange, 150, "") -RULE_BOOL(Pets, UnTargetableSwarmPet, false, "") -RULE_REAL(Pets, PetPowerLevelCap, 10, "Max number of levels your pet can go up with pet power") -RULE_BOOL(Pets, CanTakeNoDrop, false, "Can everyone trade nodrop gear to pets") +RULE_REAL(Pets, AttackCommandRange, 150, "Range at which a pet will respond to attack commands") +RULE_BOOL(Pets, UnTargetableSwarmPet, false, "Setting whether swarm pets should be targetable") +RULE_REAL(Pets, PetPowerLevelCap, 10, "Maximum number of levels a player pet can go up with pet power") +RULE_BOOL(Pets, CanTakeNoDrop, false, "Setting whether anyone can give no-drop items to pets") RULE_CATEGORY_END() RULE_CATEGORY(GM) -RULE_INT(GM, MinStatusToSummonItem, 250, "") -RULE_INT(GM, MinStatusToZoneAnywhere, 250, "") -RULE_INT(GM, MinStatusToLevelTarget, 100, "") +RULE_INT(GM, MinStatusToSummonItem, 250, "Minimum required status to summon items") +RULE_INT(GM, MinStatusToZoneAnywhere, 250, "Minimum required status to zone anywhere") +RULE_INT(GM, MinStatusToLevelTarget, 100, "Minimum required status to set the level of a player") RULE_CATEGORY_END() RULE_CATEGORY(World) -RULE_INT(World, ZoneAutobootTimeoutMS, 60000, "") -RULE_INT(World, ClientKeepaliveTimeoutMS, 65000, "") +RULE_INT(World, ZoneAutobootTimeoutMS, 60000, "Time out for automatic booting of zones in milliseconds") RULE_BOOL(World, UseBannedIPsTable, false, "Toggle whether or not to check incoming client connections against the banned_ips table. Set this value to false to disable this feature") -RULE_BOOL(World, EnableTutorialButton, true, "") -RULE_BOOL(World, EnableReturnHomeButton, true, "") -RULE_INT(World, MaxLevelForTutorial, 10, "") -RULE_INT(World, TutorialZoneID, 189, "") -RULE_INT(World, GuildBankZoneID, 345, "") -RULE_INT(World, MinOfflineTimeToReturnHome, 21600, "21600 seconds is 6 Hours") +RULE_BOOL(World, EnableTutorialButton, true, "Setting whether the Tutorial button should be active. At least in RoF2 you can always press the button, but it loses its effect") +RULE_BOOL(World, EnableReturnHomeButton, true, "Setting whether the Return Home button should be active") +RULE_INT(World, MaxLevelForTutorial, 10, "The highest level with which you can enter the tutorial") +RULE_INT(World, TutorialZoneID, 189, "Zone ID of the tutorial") +RULE_INT(World, GuildBankZoneID, 345, "Zone ID of the guild bank") +RULE_INT(World, MinOfflineTimeToReturnHome, 21600, "Minimum offline time to activate the Return Home button. 21600 seconds is 6 Hours") RULE_INT(World, MaxClientsPerIP, -1, "Maximum number of clients allowed to connect per IP address if account status is < AddMaxClientsStatus. Default value: -1 (feature disabled)") RULE_INT(World, ExemptMaxClientsStatus, -1, "Exempt accounts from the MaxClientsPerIP and AddMaxClientsStatus rules, if their status is >= this value. Default value: -1 (feature disabled)") RULE_INT(World, AddMaxClientsPerIP, -1, "Maximum number of clients allowed to connect per IP address if account status is < ExemptMaxClientsStatus. Default value: -1 (feature disabled)") RULE_INT(World, AddMaxClientsStatus, -1, "Accounts with status >= this rule will be allowed to use the amount of accounts defined in the AddMaxClientsPerIP. Default value: -1 (feature disabled)") -RULE_BOOL(World, MaxClientsSetByStatus, false, "If True, IP Limiting will be set to the status on the account as long as the status is > MaxClientsPerIP") -RULE_BOOL(World, EnableIPExemptions, false, "If True, ip_exemptions table is used, if there is no entry for the IP it will default to RuleI(World, MaxClientsPerIP)") +RULE_BOOL(World, MaxClientsSetByStatus, false, "If true, IP Limiting will be set to the status on the account as long as the status is > MaxClientsPerIP") +RULE_BOOL(World, EnableIPExemptions, false, "If true, ip_exemptions table is used, if there is no entry for the IP it will default to RuleI(World, MaxClientsPerIP)") RULE_BOOL(World, ClearTempMerchantlist, true, "Clears temp merchant items when world boots") RULE_BOOL(World, DeleteStaleCorpeBackups, true, "Deletes stale corpse backups older than 2 weeks") -RULE_BOOL(World, GMAccountIPList, false, "Check ip list against GM Accounts, AntiHack GM Accounts") -RULE_INT(World, MinGMAntiHackStatus, 1, "Minimum GM status to check against AntiHack list") +RULE_BOOL(World, GMAccountIPList, false, "Check IP list against GM accounts. This increases the security of GM accounts, e.g. if you only allow localhost '127.0.0.1' for GM accounts. Think carefully about what you enter!") +RULE_INT(World, MinGMAntiHackStatus, 1, "Minimum status to check against AntiHack list") RULE_INT(World, SoFStartZoneID, -1, "Sets the Starting Zone for SoF Clients separate from Titanium Clients (-1 is disabled)") RULE_INT(World, TitaniumStartZoneID, -1, "Sets the Starting Zone for Titanium Clients (-1 is disabled). Replaces the old method") -RULE_INT(World, ExpansionSettings, 16383, "Sets the expansion settings for the server, This is sent on login to world and affects client expansion settings. Defaults to all expansions enabled up to TSS") -RULE_BOOL(World, UseClientBasedExpansionSettings, true, "if true it will overrule World, ExpansionSettings and set someone's expansion based on the client they're using") -RULE_INT(World, PVPSettings, 0, "Sets the PVP settings for the server, 1 = Rallos Zek RuleSet, 2 = Tallon/Vallon Zek Ruleset, 4 = Sullon Zek Ruleset, 6 = Discord Ruleset, anything above 6 is the Discord Ruleset without the no-drop restrictions removed. TODO: Edit IsAttackAllowed in Zone to accomodate for these rules") -RULE_INT(World, PVPMinLevel, 0, "minimum level to pvp") -RULE_BOOL (World, IsGMPetitionWindowEnabled, false, "") -RULE_INT (World, FVNoDropFlag, 0, "Sets the Firiona Vie settings on the client. If set to 2, the flag will be set for GMs only, allowing trading of no-drop items") -RULE_BOOL (World, IPLimitDisconnectAll, false, "") +RULE_INT(World, ExpansionSettings, 16383, "Sets the expansion settings for the server, This is sent on login to world and affects client expansion settings. Defaults to all expansions enabled up to TSS, value is bitmask") +RULE_BOOL(World, UseClientBasedExpansionSettings, true, "If true it will overrule World, ExpansionSettings and set someone's expansion based on the client they're using") +RULE_INT(World, PVPSettings, 0, "Sets the PVP settings for the server. 1=Rallos Zek RuleSet, 2=Tallon/Vallon Zek Ruleset, 4=Sullon Zek Ruleset, 6=Discord Ruleset, anything above 6 is the Discord Ruleset without the no-drop restrictions removed. NOTE: edit IsAttackAllowed in Zone-table to accomodate for these rules") +RULE_INT(World, PVPMinLevel, 0, "Minimum level to pvp") +RULE_BOOL (World, IsGMPetitionWindowEnabled, false, "Setting whether the GM petition window is available") +RULE_INT (World, FVNoDropFlag, 0, "Sets the Firiona Vie settings on the client, allowing trading of no-drop items. 1=for all players, 2=for GM only") +RULE_BOOL (World, IPLimitDisconnectAll, false, "Disconnect all current clients by IP if they go over the IP limit. This should allow people to quickly reconnect in the case of dead sessions waiting to timeout") RULE_BOOL(World, MaxClientsSimplifiedLogic, false, "New logic that only uses ExemptMaxClientsStatus and MaxClientsPerIP. Done on the loginserver. This mimics the P99-style special IP rules") -RULE_INT (World, TellQueueSize, 20, "") -RULE_BOOL(World, StartZoneSameAsBindOnCreation, true, "Should the start zone ALWAYS be the same location as your bind?") -RULE_BOOL(World, EnforceCharacterLimitAtLogin, false, "") +RULE_INT (World, TellQueueSize, 20, "Maximum tell queue size") +RULE_BOOL(World, StartZoneSameAsBindOnCreation, true, "Should the start zone always be the same location as your bind?") +RULE_BOOL(World, EnforceCharacterLimitAtLogin, false, "Enforce the limit for characters that are online at login") RULE_CATEGORY_END() RULE_CATEGORY(Zone) -RULE_INT(Zone, ClientLinkdeadMS, 90000, "the time a client remains link dead on the server after a sudden disconnection") -RULE_INT(Zone, GraveyardTimeMS, 1200000, "ms time until a player corpse is moved to a zone's graveyard, if one is specified for the zone") -RULE_BOOL(Zone, EnableShadowrest, 1, "enables or disables the shadowrest zone feature for player corpses. Default is turned on") +RULE_INT(Zone, ClientLinkdeadMS, 90000, "The time a client remains link dead on the server after a sudden disconnection (milliseconds)") +RULE_INT(Zone, GraveyardTimeMS, 1200000, "Time until a player corpse is moved to a zone's graveyard, if one is specified for the zone (milliseconds)") +RULE_BOOL(Zone, EnableShadowrest, 1, "Enables or disables the Shadowrest zone feature for player corpses. Default is turned on") RULE_BOOL(Zone, UsePlayerCorpseBackups, true, "Keeps backups of player corpses") RULE_INT(Zone, MQWarpExemptStatus, -1, "Required status level to exempt the MQWarpDetector. Set to -1 to disable this feature") RULE_INT(Zone, MQZoneExemptStatus, -1, "Required status level to exempt the MQZoneDetector. Set to -1 to disable this feature") @@ -262,20 +260,19 @@ RULE_BOOL(Zone, EnableMQWarpDetector, true, "Enable the MQWarp Detector. Set to RULE_BOOL(Zone, EnableMQZoneDetector, true, "Enable the MQZone Detector. Set to False to disable this feature") RULE_BOOL(Zone, EnableMQGateDetector, true, "Enable the MQGate Detector. Set to False to disable this feature") RULE_BOOL(Zone, EnableMQGhostDetector, true, "Enable the MQGhost Detector. Set to False to disable this feature") -RULE_REAL(Zone, MQWarpDetectionDistanceFactor, 9.0, "clients move at 4.4 about if in a straight line but with movement and to acct for lag we raise it a bit") -RULE_BOOL(Zone, MarkMQWarpLT, false, "") -RULE_INT(Zone, AutoShutdownDelay, 5000, "How long a dynamic zone stays loaded while empty") -RULE_INT(Zone, PEQZoneReuseTime, 900, "How long, in seconds, until you can reuse the #peqzone command") +RULE_REAL(Zone, MQWarpDetectionDistanceFactor, 9.0, "Distance factor for MQ-Warp detection. Clients move at 4.4 about if in a straight line but with movement and to acct for lag we raise it a bit") +RULE_INT(Zone, AutoShutdownDelay, 5000, "How long a dynamic zone stays loaded while empty (milliseconds)") +RULE_INT(Zone, PEQZoneReuseTime, 900, "Time between two uses of the #peqzone command (seconds)") RULE_INT(Zone, PEQZoneDebuff1, 4454, "First debuff casted by #peqzone Default is Cursed Keeper's Blight") RULE_INT(Zone, PEQZoneDebuff2, 2209, "Second debuff casted by #peqzone Default is Tendrils of Apathy") -RULE_BOOL(Zone, UsePEQZoneDebuffs, true, "Will determine if #peqzone will debuff players or not when used") -RULE_REAL(Zone, HotZoneBonus, 0.75, "") -RULE_INT(Zone, EbonCrystalItemID, 40902, "") -RULE_INT(Zone, RadiantCrystalItemID, 40903, "") -RULE_BOOL(Zone, LevelBasedEXPMods, false, "Allows you to use the level_exp_mods table in consideration to your players EXP hits") +RULE_BOOL(Zone, UsePEQZoneDebuffs, true, "Setting if the command #peqzone applies the defined debuffs") +RULE_REAL(Zone, HotZoneBonus, 0.75, "Value which is added to the experience multiplier. This also applies to AA experience.") +RULE_INT(Zone, EbonCrystalItemID, 40902, "Item ID for Ebon Crystal") +RULE_INT(Zone, RadiantCrystalItemID, 40903, "Item ID for Radiant Crystal") +RULE_BOOL(Zone, LevelBasedEXPMods, false, "Allows you to use the level_exp_mods table in consideration to your players experience hits") RULE_INT(Zone, WeatherTimer, 600, "Weather timer when no duration is available") -RULE_BOOL(Zone, EnableLoggedOffReplenishments, true, "") -RULE_INT(Zone, MinOfflineTimeToReplenishments, 21600, "21600 seconds is 6 Hours") +RULE_BOOL(Zone, EnableLoggedOffReplenishments, true, "'Replenish mana/hp/end if logged off for MinOfflineTimeToReplenishments") +RULE_INT(Zone, MinOfflineTimeToReplenishments, 21600, "Minimum time a player must be offline before LoggedOffReplenishments becomes active (seconds)") RULE_BOOL(Zone, UseZoneController, true, "Enables the ability to use persistent quest based zone controllers (zone_controller.pl/lua)") RULE_BOOL(Zone, EnableZoneControllerGlobals, false, "Enables the ability to use quest globals with the zone controller NPC") RULE_INT(Zone, GlobalLootMultiplier, 1, "Sets Global Loot drop multiplier for database based drops, useful for double, triple loot etc") @@ -284,11 +281,11 @@ RULE_INT(Zone, SecondsBeforeIdle, 60, "Seconds before IDLE_WHEN_EMPTY define kic RULE_CATEGORY_END() RULE_CATEGORY(Map) -RULE_BOOL(Map, FixPathingZOnSendTo, false, "try to repair Z coords in the SendTo routine as well") +RULE_BOOL(Map, FixPathingZOnSendTo, false, "Try to repair Z coordinates in the SendTo routine as well") RULE_BOOL(Map, FixZWhenPathing, true, "Automatically fix NPC Z coordinates when moving/pathing/engaged (Far less CPU intensive than its predecessor)") -RULE_REAL(Map, DistanceCanTravelBeforeAdjustment, 10.0, "distance a mob can path before FixZ is called, depends on FixZWhenPathing") +RULE_REAL(Map, DistanceCanTravelBeforeAdjustment, 10.0, "Distance a mob can path before FixZ is called, depends on FixZWhenPathing") RULE_BOOL(Map, MobZVisualDebug, false, "Displays spell effects determining whether or not NPC is hitting Best Z calcs (blue for hit, red for miss)") -RULE_REAL(Map, FixPathingZMaxDeltaSendTo, 20, "at runtime in SendTo: max change in Z to allow the BestZ code to apply") +RULE_REAL(Map, FixPathingZMaxDeltaSendTo, 20, "At runtime in SendTo: maximum change in Z to allow the BestZ code to apply") RULE_INT(Map, FindBestZHeightAdjust, 1, "Adds this to the current Z before seeking the best Z position") RULE_CATEGORY_END() @@ -296,9 +293,9 @@ RULE_CATEGORY(Pathing) RULE_BOOL(Pathing, Guard, true, "Enable pathing for mobs moving to their guard point") RULE_BOOL(Pathing, Find, true, "Enable pathing for FindPerson requests from the client") RULE_BOOL(Pathing, Fear, true, "Enable pathing for fear") -RULE_REAL(Pathing, NavmeshStepSize, 100.0f, "") -RULE_REAL(Pathing, ShortMovementUpdateRange, 130.0f, "") -RULE_INT(Pathing, MaxNavmeshNodes, 4092, "Max navmesh nodes in a traversable path") +RULE_REAL(Pathing, NavmeshStepSize, 100.0f, "Step size for the movement manager") +RULE_REAL(Pathing, ShortMovementUpdateRange, 130.0f, "Range for short movement updates") +RULE_INT(Pathing, MaxNavmeshNodes, 4092, "Maximum navmesh nodes in a traversable path") RULE_CATEGORY_END() RULE_CATEGORY(Watermap) @@ -314,48 +311,47 @@ RULE_REAL(Watermap, FishingLineStepSize, 1, "Basic step size for fishing calc, t RULE_CATEGORY_END() RULE_CATEGORY(Spells) -RULE_INT(Spells, AutoResistDiff, 15, "") RULE_REAL(Spells, ResistChance, 2.0, "chance to resist given no resists and same level") -RULE_REAL(Spells, ResistMod, 0.40, "multiplier, chance to resist = this * ResistAmount") +RULE_REAL(Spells, ResistMod, 0.40, "Multiplier, chance to resist = this * ResistAmount") RULE_REAL(Spells, PartialHitChance, 0.7, "The chance when a spell is resisted that it will partial hit") RULE_REAL(Spells, PartialHitChanceFear, 0.25, "The chance when a fear spell is resisted that it will partial hit") -RULE_INT(Spells, BaseCritChance, 0, "base % chance that everyone has to crit a spell") -RULE_INT(Spells, BaseCritRatio, 100, "base % bonus to damage on a successful spell crit. 100 = 2x damage") -RULE_INT(Spells, WizCritLevel, 12, "level wizards first get spell crits") -RULE_INT(Spells, WizCritChance, 7, "wiz's crit chance, on top of BaseCritChance") -RULE_INT(Spells, WizCritRatio, 0, "wiz's crit bonus, on top of BaseCritRatio (should be 0 for Live-like)") -RULE_INT(Spells, ResistPerLevelDiff, 85, "8.5 resist per level difference") +RULE_INT(Spells, BaseCritChance, 0, "Base percentage chance that everyone has to crit a spell") +RULE_INT(Spells, BaseCritRatio, 100, "Base percentage bonus to damage on a successful spell crit. 100=2xdamage") +RULE_INT(Spells, WizCritLevel, 12, "Level wizards first get spell crits") +RULE_INT(Spells, WizCritChance, 7, "Wizards crit chance, on top of BaseCritChance") +RULE_INT(Spells, WizCritRatio, 0, "Wizards crit bonus, on top of BaseCritRatio (should be 0 for Live-like)") +RULE_INT(Spells, ResistPerLevelDiff, 85, "Resist per level difference. 85=8.5") RULE_INT(Spells, TranslocateTimeLimit, 0, "If not zero, time in seconds to accept a Translocate") -RULE_INT(Spells, SacrificeMinLevel, 46, "first level Sacrifice will work on") -RULE_INT(Spells, SacrificeMaxLevel, 69, "last level Sacrifice will work on") -RULE_INT(Spells, SacrificeItemID, 9963, "Item ID of the item Sacrifice will return (defaults to an EE)") -RULE_BOOL(Spells, EnableSpellGlobals, false, "If Enabled, spells check the spell_globals table and compare character data from their quest globals before allowing the spell to scribe with scribespells/traindiscs") -RULE_BOOL(Spells, EnableSpellBuckets, false, "If Enabled, spells check the spell_buckets table and compare character data from their data buckets before allowing the spell to scribe with scribespells/traindiscs") -RULE_INT(Spells, MaxBuffSlotsNPC, 60, "default to Tit's limit") -RULE_INT(Spells, MaxSongSlotsNPC, 0, "NPCs don't have songs ...") -RULE_INT(Spells, MaxDiscSlotsNPC, 0, "NPCs don't have discs ...") -RULE_INT(Spells, MaxTotalSlotsNPC, 60, "default to Tit's limit") -RULE_INT(Spells, MaxTotalSlotsPET, 30, "default to Tit's limit") -RULE_BOOL (Spells, EnableBlockedBuffs, true, "") -RULE_INT(Spells, ReflectType, 3, "0 = disabled, 1 = single target player spells only, 2 = all player spells, 3 = all single target spells, 4 = all spells") -RULE_BOOL(Spells, ReflectMessagesClose, true, "Live functionality is for Reflect messages to show to players within close proximity, false shows just player reflecting") +RULE_INT(Spells, SacrificeMinLevel, 46, "First level the spell Sacrifice will work on") +RULE_INT(Spells, SacrificeMaxLevel, 69, "Last level the spell Sacrifice will work on") +RULE_INT(Spells, SacrificeItemID, 9963, "Item ID of the item Sacrifice will return (defaults to an Essence Emerald)") +RULE_BOOL(Spells, EnableSpellGlobals, false, "If enabled, spells check the spell_globals table and compare character data from their quest globals before allowing the spell to scribe with scribespells/traindiscs") +RULE_BOOL(Spells, EnableSpellBuckets, false, "If enabled, spells check the spell_buckets table and compare character data from their data buckets before allowing the spell to scribe with scribespells/traindiscs") +RULE_INT(Spells, MaxBuffSlotsNPC, 60, "Maximum number of NPC buff slots. The default value is the limit of the Titanium client") +RULE_INT(Spells, MaxSongSlotsNPC, 0, "Maximum number of NPC song slots. NPC don't have songs, so it should be 0") +RULE_INT(Spells, MaxDiscSlotsNPC, 0, "Maximum number of NPC disc slots. NPC don't have discs, so it should be 0") +RULE_INT(Spells, MaxTotalSlotsNPC, 60, "Maximum total of NPC slots. The default value is the limit of the Titanium client") +RULE_INT(Spells, MaxTotalSlotsPET, 30, "Maximum total of pet slots. The default value is the limit of the Titanium client") +RULE_BOOL (Spells, EnableBlockedBuffs, true, "Allow blocked spells") +RULE_INT(Spells, ReflectType, 3, "Reflect type. 0=disabled, 1=single target player spells only, 2=all player spells, 3=all single target spells, 4=all spells") +RULE_BOOL(Spells, ReflectMessagesClose, true, "True (Live functionality) is for Reflect messages to show to players within close proximity. False shows just player reflecting") RULE_INT(Spells, VirusSpreadDistance, 30, "The distance a viral spell will jump to its next victim") RULE_BOOL(Spells, LiveLikeFocusEffects, true, "Determines whether specific healing, dmg and mana reduction focuses are randomized") -RULE_INT(Spells, BaseImmunityLevel, 55, "The level that targets start to be immune to stun, fear and mez spells with a max level of 0") -RULE_BOOL(Spells, NPCIgnoreBaseImmunity, true, "Whether or not NPCs get to ignore the BaseImmunityLevel for their spells") +RULE_INT(Spells, BaseImmunityLevel, 55, "The level that targets start to be immune to stun, fear and mez spells with a maximum level of 0") +RULE_BOOL(Spells, NPCIgnoreBaseImmunity, true, "Whether or not NPCget to ignore the BaseImmunityLevel for their spells") RULE_REAL(Spells, AvgSpellProcsPerMinute, 6.0, "Adjust rate for sympathetic spell procs") -RULE_INT(Spells, ResistFalloff, 67, "Max that level that will adjust our resist chance based on level modifiers") -RULE_INT(Spells, CharismaEffectiveness, 10, "Deterimes how much resist modification charisma applies to charm/pacify checks. Default 10 CHA = -1 resist mod") -RULE_INT(Spells, CharismaEffectivenessCap, 255, "Deterimes how much resist modification charisma applies to charm/pacify checks. Default 10 CHA = -1 resist mod") +RULE_INT(Spells, ResistFalloff, 67, "Maximum that level that will adjust our resist chance based on level modifiers") +RULE_INT(Spells, CharismaEffectiveness, 10, "Determines how much resist modification charisma applies to charm/pacify checks. Default 10 CHA = -1 resist mod") +RULE_INT(Spells, CharismaEffectivenessCap, 255, "Determines how much resist modification charisma applies to charm/pacify checks. Default 10 CHA = -1 resist mod") RULE_BOOL(Spells, CharismaCharmDuration, false, "Allow CHA resist mod to extend charm duration") RULE_INT(Spells, CharmBreakCheckChance, 25, "Determines chance for a charm break check to occur each buff tick") RULE_BOOL(Spells, CharmDisablesSpecialAbilities, false, "When charm is cast on an NPC, strip their special abilities") -RULE_INT(Spells, MaxCastTimeReduction, 50, "Max percent your spell cast time can be reduced by spell haste") +RULE_INT(Spells, MaxCastTimeReduction, 50, "Maximum percent your spell cast time can be reduced by spell haste") RULE_INT(Spells, RootBreakFromSpells, 55, "Chance for root to break when cast on") RULE_INT(Spells, DeathSaveCharismaMod, 3, "Determines how much charisma effects chance of death save firing") RULE_INT(Spells, DivineInterventionHeal, 8000, "Divine intervention heal amount") RULE_INT(Spells, AdditiveBonusWornType, 0, "Calc worn bonuses to add together (instead of taking highest) if set to THIS worn type. (2=Will covert live items automatically)") -RULE_BOOL(Spells, UseCHAScribeHack, false, "ScribeSpells and TrainDiscs quest functions will ignore entries where field 12 is CHA. What's the best way to do this?") +RULE_BOOL(Spells, UseCHAScribeHack, false, "ScribeSpells and TrainDiscs quest functions will ignore entries where field 12 is CHA") RULE_BOOL(Spells, BuffLevelRestrictions, true, "Buffs will not land on low level toons like live") RULE_INT(Spells, RootBreakCheckChance, 70, "Determines chance for a root break check to occur each buff tick") RULE_INT(Spells, FearBreakCheckChance, 70, "Determines chance for a fear break check to occur each buff tick") @@ -366,166 +362,166 @@ RULE_INT(Spells, FRProjectileItem_NPC, 80684, "Item id for NPC Fire 'spell proje RULE_BOOL(Spells, UseLiveSpellProjectileGFX, false, "Use spell projectile graphics set in the spells_new table (player_1). Server must be using UF+ spell file") RULE_BOOL(Spells, FocusCombatProcs, false, "Allow all combat procs to receive focus effects") RULE_BOOL(Spells, PreNerfBardAEDoT, false, "Allow bard AOE dots to damage targets when moving") -RULE_INT(Spells, AI_SpellCastFinishedFailRecast, 800, "AI spell recast time(MS) when an spell is cast but fails (ie stunned)") -RULE_INT(Spells, AI_EngagedNoSpellMinRecast, 500, "AI spell recast time(MS) check when no spell is cast while engaged. (min time in random)") -RULE_INT(Spells, AI_EngagedNoSpellMaxRecast, 1000, "AI spell recast time(MS) check when no spell is cast engaged.(max time in random)") +RULE_INT(Spells, AI_SpellCastFinishedFailRecast, 800, "AI spell recast time when an spell is cast but fails, ie if stunned (milliseconds)") +RULE_INT(Spells, AI_EngagedNoSpellMinRecast, 500, "AI spell recast time check when no spell is cast while engaged. Min time in random (milliseconds)") +RULE_INT(Spells, AI_EngagedNoSpellMaxRecast, 1000, "AI spell recast time check when no spell is cast engaged. Mmaximum time in random (milliseconds)") RULE_INT(Spells, AI_EngagedBeneficialSelfChance, 100, "Chance during first AI Cast check to do a beneficial spell on self") RULE_INT(Spells, AI_EngagedBeneficialOtherChance, 25, "Chance during second AI Cast check to do a beneficial spell on others") RULE_INT(Spells, AI_EngagedDetrimentalChance, 20, "Chance during third AI Cast check to do a determental spell on others") -RULE_INT(Spells, AI_PursueNoSpellMinRecast, 500, "AI spell recast time(MS) check when no spell is cast while chasing target. (min time in random)") -RULE_INT(Spells, AI_PursueNoSpellMaxRecast, 2000, "AI spell recast time(MS) check when no spell is cast while chasing target. (max time in random)") +RULE_INT(Spells, AI_PursueNoSpellMinRecast, 500, "AI spell recast time check when no spell is cast while chasing target. Mmin time in random (milliseconds)") +RULE_INT(Spells, AI_PursueNoSpellMaxRecast, 2000, "AI spell recast time check when no spell is cast while chasing target. Maximum time in random (milliseconds)") RULE_INT(Spells, AI_PursueDetrimentalChance, 90, "Chance while chasing target to cast a detrimental spell") -RULE_INT(Spells, AI_IdleNoSpellMinRecast, 6000, "AI spell recast time(MS) check when no spell is cast while idle. (min time in random)") -RULE_INT(Spells, AI_IdleNoSpellMaxRecast, 60000, "AI spell recast time(MS) check when no spell is cast while chasing target. (max time in random)") +RULE_INT(Spells, AI_IdleNoSpellMinRecast, 6000, "AI spell recast time check when no spell is cast while idle. Mmin time in random (milliseconds)") +RULE_INT(Spells, AI_IdleNoSpellMaxRecast, 60000, "AI spell recast time check when no spell is cast while chasing target. Maximum time in random (milliseconds)") RULE_INT(Spells, AI_IdleBeneficialChance, 100, "Chance while idle to do a beneficial spell on self or others") -RULE_INT(Spells, AI_HealHPPct, 50, "HP Pct NPCs will start heals at (in and out of combat) if spell's max_hp is not set") -RULE_BOOL(Spells, SHDProcIDOffByOne, true, "pre June 2009 SHD spell procs were off by 1, they stopped doing this in June 2009 (so UF+ spell files need this false)") -RULE_BOOL(Spells, Jun182014HundredHandsRevamp, false, "this should be true for if you import a spell file newer than June 18, 2014") +RULE_INT(Spells, AI_HealHPPct, 50, "Hitpoint percentage at which NPC starts healing when max_hp of the spell is not set (inside and outside combat)") +RULE_BOOL(Spells, SHDProcIDOffByOne, true, "Pre June 2009 SHD spell procs were off by 1, they stopped doing this in June 2009 (UF+ spell files need this false)") +RULE_BOOL(Spells, Jun182014HundredHandsRevamp, false, "This should be true for if you import a spell file newer than June 18, 2014") RULE_BOOL(Spells, SwarmPetTargetLock, false, "Use old method of swarm pets target locking till target dies then despawning") -RULE_BOOL(Spells, NPC_UseFocusFromSpells, true, "Allow npcs to use most spell derived focus effects") -RULE_BOOL(Spells, NPC_UseFocusFromItems, false, "Allow npcs to use most item derived focus effects") +RULE_BOOL(Spells, NPC_UseFocusFromSpells, true, "Allow NPC to use most spell derived focus effects") +RULE_BOOL(Spells, NPC_UseFocusFromItems, false, "Allow NPC to use most item derived focus effects") RULE_BOOL(Spells, UseAdditiveFocusFromWornSlot, false, "Allows an additive focus effect to be calculated from worn slot") -RULE_BOOL(Spells, AlwaysSendTargetsBuffs, false, "ignore LAA level if true") -RULE_BOOL(Spells, FlatItemExtraSpellAmt, false, "allow SpellDmg stat to affect all spells, regardless of cast time/cooldown/etc") -RULE_BOOL(Spells, IgnoreSpellDmgLvlRestriction, false, "ignore the 5 level spread on applying SpellDmg") -RULE_BOOL(Spells, AllowItemTGB, false, "TGB doesn't work with items on live, custom servers want it though") +RULE_BOOL(Spells, AlwaysSendTargetsBuffs, false, "Ignore Leadership Alternate Abilities level if true") +RULE_BOOL(Spells, FlatItemExtraSpellAmt, false, "Allow SpellDmg stat to affect all spells, regardless of cast time/cooldown/etc") +RULE_BOOL(Spells, IgnoreSpellDmgLvlRestriction, false, "Ignore the 5 level spread on applying SpellDmg") +RULE_BOOL(Spells, AllowItemTGB, false, "Target group buff (/tgb) doesn't work with items on live, custom servers want it though") RULE_BOOL(Spells, NPCInnateProcOverride, true, "NPC innate procs override the target type to single target") -RULE_BOOL(Spells, OldRainTargets, false, "use old incorrectly implemented max targets for rains") -RULE_BOOL(Spells, NPCSpellPush, false, "enable spell push on NPCs") +RULE_BOOL(Spells, OldRainTargets, false, "Use old incorrectly implemented maximum targets for rains") +RULE_BOOL(Spells, NPCSpellPush, false, "Enable spell push on NPCs") RULE_CATEGORY_END() RULE_CATEGORY(Combat) -RULE_INT(Combat, PetBaseCritChance, 0, "Pet Base crit chance") -RULE_INT(Combat, NPCBashKickLevel, 6, "The level that npcs can KICK/BASH") +RULE_INT(Combat, PetBaseCritChance, 0, "Pet base crit chance") +RULE_INT(Combat, NPCBashKickLevel, 6, "The level that NPCcan KICK/BASH") RULE_INT(Combat, NPCBashKickStunChance, 15, "Percent chance that a bash/kick will stun") -RULE_INT(Combat, MeleeCritDifficulty, 8900, "lower is easier") -RULE_INT(Combat, ArcheryCritDifficulty, 3400, "lower is easier") -RULE_INT(Combat, ThrowingCritDifficulty, 1100, "lower is easier") -RULE_BOOL(Combat, NPCCanCrit, false, "true allows non PC pet NPCs to crit") -RULE_BOOL(Combat, UseIntervalAC, true, "") -RULE_INT(Combat, PetAttackMagicLevel, 30, "") -RULE_BOOL(Combat, EnableFearPathing, true, "") +RULE_INT(Combat, MeleeCritDifficulty, 8900, "Value against which is rolled to check if a melee crit is triggered. Lower is easier") +RULE_INT(Combat, ArcheryCritDifficulty, 3400, "Value against which is rolled to check if a archery crit is triggered. Lower is easier") +RULE_INT(Combat, ThrowingCritDifficulty, 1100, "Value against which is rolled to check if a throwing crit is triggered. Lower is easier") +RULE_BOOL(Combat, NPCCanCrit, false, "Setting whether an NPC can land critical hits") +RULE_BOOL(Combat, UseIntervalAC, true, "Switch whether bonuses, armour class, multipliers, classes and caps should be considered in the calculation of damage values") +RULE_INT(Combat, PetAttackMagicLevel, 30, "Level at which pets can cause magic damage") +RULE_BOOL(Combat, EnableFearPathing, true, "Setting whether to use pathing during fear") RULE_REAL(Combat, FleeMultiplier, 2.0, "Determines how quickly a NPC will slow down while fleeing. Decrease multiplier to slow NPC down quicker") RULE_BOOL(Combat, FleeGray, true, "If true FleeGrayHPRatio will be used") -RULE_INT(Combat, FleeGrayHPRatio, 50, "HP % when a Gray NPC begins to flee") -RULE_INT(Combat, FleeGrayMaxLevel, 18, "NPC's above this level won't do gray/green con flee") -RULE_INT(Combat, FleeHPRatio, 25, "HP % when a NPC begins to flee") +RULE_INT(Combat, FleeGrayHPRatio, 50, "HP percentage when a Gray NPC begins to flee") +RULE_INT(Combat, FleeGrayMaxLevel, 18, "NPC above this level won't do gray/green con flee") +RULE_INT(Combat, FleeHPRatio, 25, "HP percentage when a NPC begins to flee") RULE_BOOL(Combat, FleeIfNotAlone, false, "If false, mobs won't flee if other mobs are in combat with it") -RULE_BOOL(Combat, AdjustProcPerMinute, true, "") -RULE_REAL(Combat, AvgProcsPerMinute, 2.0, "") -RULE_REAL(Combat, ProcPerMinDexContrib, 0.075, "") -RULE_REAL(Combat, BaseProcChance, 0.035, "") -RULE_REAL(Combat, ProcDexDivideBy, 11000, "") +RULE_BOOL(Combat, AdjustProcPerMinute, true, "Adapt the average proc rate to the speed of the weapon") +RULE_REAL(Combat, AvgProcsPerMinute, 2.0, "Average proc rate per minute") +RULE_REAL(Combat, ProcPerMinDexContrib, 0.075, "Increases the probability of a proc increased by DEX by the value indicated") +RULE_REAL(Combat, BaseProcChance, 0.035, "Base chance for procs") +RULE_REAL(Combat, ProcDexDivideBy, 11000, "Divisor for the probability of a proc increased by dexterity") RULE_BOOL(Combat, AdjustSpecialProcPerMinute, true, "Set PPM for special abilities like HeadShot (Live does this as of 4-14)") RULE_REAL(Combat, AvgSpecialProcsPerMinute, 2.0, "Unclear what best value is atm") -RULE_REAL(Combat, BaseHitChance, 69.0, "") -RULE_REAL(Combat, NPCBonusHitChance, 26.0, "") -RULE_REAL(Combat, HitFalloffMinor, 5.0, "hit will fall off up to 5% over the initial level range") -RULE_REAL(Combat, HitFalloffModerate, 7.0, "hit will fall off up to 7% over the three levels after the initial level range") -RULE_REAL(Combat, HitFalloffMajor, 50.0, "hit will fall off sharply if we're outside the minor and moderate range") -RULE_REAL(Combat, HitBonusPerLevel, 1.2, "You gain this % of hit for every level you are above your target") -RULE_REAL(Combat, WeaponSkillFalloff, 0.33, "For every weapon skill point that's not maxed you lose this % of hit") +RULE_REAL(Combat, BaseHitChance, 69.0, "Base chance to hiz") +RULE_REAL(Combat, NPCBonusHitChance, 26.0, "Bonus chance to hit for NPC") +RULE_REAL(Combat, HitFalloffMinor, 5.0, "Hit will fall off up to value over the initial level range (percent)") +RULE_REAL(Combat, HitFalloffModerate, 7.0, "Hit will fall off up to value over the three levels after the initial level range (percent)") +RULE_REAL(Combat, HitFalloffMajor, 50.0, "Hit will fall off sharply if we're outside the minor and moderate range") +RULE_REAL(Combat, HitBonusPerLevel, 1.2, "You gain this percentage of hit for every level you are above your target") +RULE_REAL(Combat, WeaponSkillFalloff, 0.33, "For every weapon skill point that's not maxed you lose this percentage of hit") RULE_REAL(Combat, ArcheryHitPenalty, 0.25, "Archery has a hit penalty to try to help balance it with the plethora of long term +hit modifiers for it") -RULE_REAL(Combat, AgiHitFactor, 0.01, "") -RULE_REAL(Combat, MinChancetoHit, 5.0, "Minimum % chance to hit with regular melee/ranged") -RULE_REAL(Combat, MaxChancetoHit, 95.0, "Maximum % chance to hit with regular melee/ranged") +RULE_REAL(Combat, AgiHitFactor, 0.01, "Factor with which agility is taken into account in the hit probability. Higher is better") +RULE_REAL(Combat, MinChancetoHit, 5.0, "Minimum percentage chance to hit with regular melee/ranged") +RULE_REAL(Combat, MaxChancetoHit, 95.0, "Maximum percentage chance to hit with regular melee/ranged") RULE_INT(Combat, MinRangedAttackDist, 25, "Minimum Distance to use Ranged Attacks") RULE_BOOL(Combat, ArcheryBonusRequiresStationary, true, "does the 2x archery bonus chance require a stationary npc") -RULE_REAL(Combat, ArcheryBaseDamageBonus, 1, "% Modifier to Base Archery Damage (.5 = 50% base damage, 1 = 100%, 2 = 200%)") -RULE_REAL(Combat, ArcheryNPCMultiplier, 1.0, "this is multiplied by the regular dmg to get the archery dmg") -RULE_BOOL(Combat, AssistNoTargetSelf, true, "when assisting a target that does not have a target: true = target self, false = leave target as was before assist (false = live like)") -RULE_INT(Combat, MaxRampageTargets, 3, "max number of people hit with rampage") -RULE_INT(Combat, DefaultRampageTargets, 1, "default number of people to hit with rampage") -RULE_BOOL(Combat, RampageHitsTarget, false, "rampage will hit the target if it still has targets left") -RULE_INT(Combat, MaxFlurryHits, 2, "max number of extra hits from flurry") -RULE_INT(Combat, MonkDamageTableBonus, 5, "% bonus monks get to their damage table calcs") -RULE_INT(Combat, FlyingKickBonus, 25, "% Modifier that this skill gets to str and skill bonuses") -RULE_INT(Combat, DragonPunchBonus, 20, "% Modifier that this skill gets to str and skill bonuses") -RULE_INT(Combat, EagleStrikeBonus, 15, "% Modifier that this skill gets to str and skill bonuses") -RULE_INT(Combat, TigerClawBonus, 10, "% Modifier that this skill gets to str and skill bonuses") -RULE_INT(Combat, RoundKickBonus, 5, "% Modifier that this skill gets to str and skill bonuses") -RULE_INT(Combat, FrenzyBonus, 0, "% Modifier to damage") -RULE_INT(Combat, BackstabBonus, 0, "% Modifier to damage") +RULE_REAL(Combat, ArcheryBaseDamageBonus, 1, "Percentage modifier to base archery Damage 0.5=50% base damage, 1=100%,2=200%") +RULE_REAL(Combat, ArcheryNPCMultiplier, 1.0, "Value is multiplied by the regular dmg to get the archery dmg") +RULE_BOOL(Combat, AssistNoTargetSelf, true, "When assisting a target that does not have a target: true = target self, false = leave target as was before assist (false = live like)") +RULE_INT(Combat, MaxRampageTargets, 3, "Maximum number of people hit with rampage") +RULE_INT(Combat, DefaultRampageTargets, 1, "Default number of people to hit with rampage") +RULE_BOOL(Combat, RampageHitsTarget, false, "Rampage will hit the target if it still has targets left") +RULE_INT(Combat, MaxFlurryHits, 2, "Maximum number of extra hits from flurry") +RULE_INT(Combat, MonkDamageTableBonus, 5, "Percentage bonus monks get to their damage table calcs") +RULE_INT(Combat, FlyingKickBonus, 25, "Percentage Modifier that this skill gets to str and skill bonuses") +RULE_INT(Combat, DragonPunchBonus, 20, "Percentage Modifier that this skill gets to str and skill bonuses") +RULE_INT(Combat, EagleStrikeBonus, 15, "Percentage Modifier that this skill gets to str and skill bonuses") +RULE_INT(Combat, TigerClawBonus, 10, "Percentage Modifier that this skill gets to str and skill bonuses") +RULE_INT(Combat, RoundKickBonus, 5, "Percentage Modifier that this skill gets to str and skill bonuses") +RULE_INT(Combat, FrenzyBonus, 0, "Percentage Modifier to damage") +RULE_INT(Combat, BackstabBonus, 0, "Percentage Modifier to damage") RULE_BOOL(Combat, ProcTargetOnly, true, "true = procs will only affect our target, false = procs will affect all of our targets") -RULE_REAL(Combat, NPCACFactor, 2.25, "") -RULE_INT(Combat, ClothACSoftcap, 75, "") -RULE_INT(Combat, LeatherACSoftcap, 100, "") -RULE_INT(Combat, MonkACSoftcap, 120, "") -RULE_INT(Combat, ChainACSoftcap, 200, "") -RULE_INT(Combat, PlateACSoftcap, 300, "") -RULE_REAL(Combat, AAMitigationACFactor, 3.0, "") -RULE_REAL(Combat, WarriorACSoftcapReturn, 0.45, "") -RULE_REAL(Combat, KnightACSoftcapReturn, 0.33, "") -RULE_REAL(Combat, LowPlateChainACSoftcapReturn, 0.23, "") -RULE_REAL(Combat, LowChainLeatherACSoftcapReturn, 0.17, "") -RULE_REAL(Combat, CasterACSoftcapReturn, 0.06, "") -RULE_REAL(Combat, MiscACSoftcapReturn, 0.3, "") -RULE_BOOL(Combat, OldACSoftcapRules, false, "use old softcaps") -RULE_BOOL(Combat, UseOldDamageIntervalRules, false, "use old damage formulas for everything") -RULE_REAL(Combat, WarACSoftcapReturn, 0.3448, "new AC returns") -RULE_REAL(Combat, ClrRngMnkBrdACSoftcapReturn, 0.3030, "") -RULE_REAL(Combat, PalShdACSoftcapReturn, 0.3226, "") -RULE_REAL(Combat, DruNecWizEncMagACSoftcapReturn, 0.2000, "") -RULE_REAL(Combat, RogShmBstBerACSoftcapReturn, 0.2500, "") -RULE_REAL(Combat, SoftcapFactor, 1.88, "") -RULE_REAL(Combat, ACthac0Factor, 0.55, "") -RULE_REAL(Combat, ACthac20Factor, 0.55, "") -RULE_INT(Combat, HitCapPre20, 40, "live has it capped at 40 for whatever dumb reason... this is mainly for custom servers") -RULE_INT(Combat, HitCapPre10, 20, "live has it capped at 20, see above") -RULE_INT(Combat, MinHastedDelay, 400, "how fast we can get with haste") -RULE_REAL(Combat, AvgDefProcsPerMinute, 2.0, "") +RULE_REAL(Combat, NPCACFactor, 2.25, "If UseIntervalAC is enabled, the armor class for NPC is divided by this value") +RULE_INT(Combat, ClothACSoftcap, 75, "If OldACSoftcapRules is true: armorclass softcap for cloth armor") +RULE_INT(Combat, LeatherACSoftcap, 100, "If OldACSoftcapRules is true: armorclass softcap for leather armor") +RULE_INT(Combat, MonkACSoftcap, 120, "If OldACSoftcapRules is true: armorclass softcap for monks") +RULE_INT(Combat, ChainACSoftcap, 200, "If OldACSoftcapRules is true: armorclass softcap for chain armor") +RULE_INT(Combat, PlateACSoftcap, 300, "If OldACSoftcapRules is true: armorclass softcap for plate armor") +RULE_REAL(Combat, AAMitigationACFactor, 3.0, "If OldACSoftcapRules: AA mitgation armorclass factor") +RULE_REAL(Combat, WarriorACSoftcapReturn, 0.45, "If OldACSoftcapRules: warrior armorclass softcap increase-factor") +RULE_REAL(Combat, KnightACSoftcapReturn, 0.33, "If OldACSoftcapRules: SHD/PAL/MNK armorclass softcap increase-factor") +RULE_REAL(Combat, LowPlateChainACSoftcapReturn, 0.23, "If OldACSoftcapRules: CLR/BRD/BSK/ROG/SHA/MNK armorclass softcap increase-factor") +RULE_REAL(Combat, LowChainLeatherACSoftcapReturn, 0.17, "If OldACSoftcapRules: RNG/BST armorclass softcap increase-factor") +RULE_REAL(Combat, CasterACSoftcapReturn, 0.06, "If OldACSoftcapRules: WIZ/MAG/NEC/ENC/DRU armorclass softcap increase-factor") +RULE_REAL(Combat, MiscACSoftcapReturn, 0.3, "If OldACSoftcapRules true/false: unspecified classes armorclass softcap increase-factor") +RULE_BOOL(Combat, OldACSoftcapRules, false, "Setting if the old softcap values should be used") +RULE_BOOL(Combat, UseOldDamageIntervalRules, false, "Use old damage formulas for everything") +RULE_REAL(Combat, WarACSoftcapReturn, 0.3448, "WAR armorclass softcap increase-factor") +RULE_REAL(Combat, ClrRngMnkBrdACSoftcapReturn, 0.3030, "CLR/RNG/MNK/BRD armorclass softcap increase-factor") +RULE_REAL(Combat, PalShdACSoftcapReturn, 0.3226, "SHD/PAL armorclass softcap increase-factor") +RULE_REAL(Combat, DruNecWizEncMagACSoftcapReturn, 0.2000, "DRU/NEC/WIZ/ENC/MAG softcap increase-factor") +RULE_REAL(Combat, RogShmBstBerACSoftcapReturn, 0.2500, "ROG/SHM/BST/BER softcap increase-factor") +RULE_REAL(Combat, SoftcapFactor, 1.88, "When UseIntervalAC is enabled, the softcap for mitigation capability is multiplied by this value") +RULE_REAL(Combat, ACthac0Factor, 0.55, "If a mob is attacked and the attack roll is greater than his defense roll, the attack rating is multiplied by this value") +RULE_REAL(Combat, ACthac20Factor, 0.55, "If a mob is attacked and his defense roll is greater than the attack roll, the attack rating is multiplied by this value") +RULE_INT(Combat, HitCapPre20, 40, "Hit cap before level 20. Live has it capped at 40") +RULE_INT(Combat, HitCapPre10, 20, "Hit cap before level 10. Live has it capped at 20") +RULE_INT(Combat, MinHastedDelay, 400, "Minimum hasted combat delay") +RULE_REAL(Combat, AvgDefProcsPerMinute, 2.0, "Average defense procs per minute") RULE_REAL(Combat, DefProcPerMinAgiContrib, 0.075, "How much agility contributes to defensive proc rate") RULE_INT(Combat, SpecialAttackACBonus, 15, "Percent amount of damage per AC gained for certain special attacks (damage = AC*SpecialAttackACBonus/100)") RULE_INT(Combat, NPCFlurryChance, 20, "Chance for NPC to flurry") RULE_BOOL (Combat,TauntOverLevel, 1, "Allows you to taunt NPC's over warriors level") -RULE_REAL (Combat,TauntSkillFalloff, 0.33, "For every taunt skill point that's not maxed you lose this % chance to taunt") -RULE_BOOL (Combat,EXPFromDmgShield, false, "Determine if damage from a damage shield counts for EXP gain") -RULE_INT(Combat, MonkACBonusWeight, 15, "") +RULE_REAL (Combat,TauntSkillFalloff, 0.33, "For every taunt skill point that's not maxed you lose this percentage chance to taunt") +RULE_BOOL (Combat,EXPFromDmgShield, false, "Determine if damage from a damage shield counts for experience gain") +RULE_INT(Combat, MonkACBonusWeight, 15, "Usually, a monk under this weight threshold gets an AC bonus") RULE_INT(Combat, ClientStunLevel, 55, "This is the level where client kicks and bashes can stun the target") RULE_INT(Combat, QuiverHasteCap, 1000, "Quiver haste cap 1000 on live for a while, currently 700 on live") RULE_BOOL(Combat, UseArcheryBonusRoll, false, "Make the 51+ archery bonus require an actual roll") -RULE_INT(Combat, ArcheryBonusChance, 50, "") -RULE_INT(Combat, BerserkerFrenzyStart, 35, "") -RULE_INT(Combat, BerserkerFrenzyEnd, 45, "") +RULE_INT(Combat, ArcheryBonusChance, 50, "Chance for 50+ archery bonus damage if Combat:UseArcheryBonusRoll is true") +RULE_INT(Combat, BerserkerFrenzyStart, 35, "Percentage Health Points below which Warrior and Berserker start frenzy") +RULE_INT(Combat, BerserkerFrenzyEnd, 45, "Percentage Health Points above which Warrior and Berserker end frenzy") RULE_BOOL(Combat, OneProcPerWeapon, true, "If enabled, One proc per weapon per round") RULE_BOOL(Combat, ProjectileDmgOnImpact, true, "If enabled, projectiles (ie arrows) will hit on impact, instead of instantly") -RULE_BOOL(Combat, MeleePush, true, "enable melee push") -RULE_INT(Combat, MeleePushChance, 50, "(NPCs) chance the target will be pushed. Made up, 100 actually isn't that bad") -RULE_BOOL(Combat, UseLiveCombatRounds, true, "turn this false if you don't want to worry about fixing up combat rounds for NPCs") -RULE_INT(Combat, NPCAssistCap, 5, "Maxiumium number of NPCs that will assist another NPC at once") -RULE_INT(Combat, NPCAssistCapTimer, 6000, "Time in milliseconds a NPC will take to clear assist aggro cap space") -RULE_BOOL(Combat, UseRevampHandToHand, false, "use h2h revamped dmg/delays I believe this was implemented during SoF") -RULE_BOOL(Combat, ClassicMasterWu, false, "classic master wu uses a random special, modern doesn't") -RULE_INT(Combat, LevelToStopDamageCaps, 0, "1 will effectively disable them, 20 should give basically same results as old incorrect system") -RULE_INT(Combat, LevelToStopACTwinkControl, 50, "1 will effectively disable it, 50 should give basically same results as current system") -RULE_BOOL(Combat, ClassicNPCBackstab, false, "true disables npc facestab - npcs get normal attack if not behind") +RULE_BOOL(Combat, MeleePush, true, "Eenable melee push") +RULE_INT(Combat, MeleePushChance, 50, "NPC chance the target will be pushed. Made up, 100 actually isn't that bad") +RULE_BOOL(Combat, UseLiveCombatRounds, true, "Turn this false if you don't want to worry about fixing up combat rounds for NPCs") +RULE_INT(Combat, NPCAssistCap, 5, "Maxiumium number of NPCthat will assist another NPC at once") +RULE_INT(Combat, NPCAssistCapTimer, 6000, "Time a NPC will take to clear assist aggro cap space (milliseconds)") +RULE_BOOL(Combat, UseRevampHandToHand, false, "Use h2h revamped dmg/delays I believe this was implemented during SoF") +RULE_BOOL(Combat, ClassicMasterWu, false, "Classic master wu uses a random special, modern doesn't") +RULE_INT(Combat, LevelToStopDamageCaps, 0, "Level to stop damage caps. 1 will effectively disable them, 20 should give basically same results as old incorrect system") +RULE_INT(Combat, LevelToStopACTwinkControl, 50, "Level to stop armorclass twink control. 1 will effectively disable it, 50 should give basically same results as current system") +RULE_BOOL(Combat, ClassicNPCBackstab, false, "True disables npc facestab - NPCget normal attack if not behind") RULE_BOOL(Combat, UseNPCDamageClassLevelMods, true, "Uses GetClassLevelDamageMod calc in npc_scale_manager") RULE_BOOL(Combat, UseExtendedPoisonProcs, false, "Allow old school poisons to last until characrer zones, at a lower proc rate") RULE_CATEGORY_END() RULE_CATEGORY(NPC) -RULE_INT(NPC, MinorNPCCorpseDecayTimeMS, 450000, "level < 55") -RULE_INT(NPC, MajorNPCCorpseDecayTimeMS, 1500000, "level >= 55") -RULE_INT(NPC, CorpseUnlockTimer, 150000, "") -RULE_INT(NPC, EmptyNPCCorpseDecayTimeMS, 0, "") -RULE_BOOL(NPC, UseItemBonusesForNonPets, true, "") -RULE_BOOL(NPC, UseBaneDamage, false, "") -RULE_INT(NPC, SayPauseTimeInSec, 5, "") -RULE_INT(NPC, OOCRegen, 0, "") -RULE_BOOL(NPC, BuffFriends, false, "") -RULE_BOOL(NPC, EnableNPCQuestJournal, false, "") -RULE_INT(NPC, LastFightingDelayMovingMin, 10000, "") -RULE_INT(NPC, LastFightingDelayMovingMax, 20000, "") -RULE_BOOL(NPC, SmartLastFightingDelayMoving, true, "") -RULE_BOOL(NPC, ReturnNonQuestNoDropItems, false, "Returns NO DROP items on NPCs that don't have an EVENT_TRADE sub in their script") -RULE_INT(NPC, StartEnrageValue, 9, "% HP that an NPC will begin to enrage") +RULE_INT(NPC, MinorNPCCorpseDecayTimeMS, 450000, "NPC corpse decay time, if NPC below level 55 (milliseconds)") +RULE_INT(NPC, MajorNPCCorpseDecayTimeMS, 1500000, "NPC corpse decay time, if NPC equal or greater than level 55 (milliseconds)") +RULE_INT(NPC, CorpseUnlockTimer, 150000, "Time after which corpses are unlocked for everyone to loot (milliseconds)") +RULE_INT(NPC, EmptyNPCCorpseDecayTimeMS, 0, "NPC corpse decay time, if no items are left on the corpse (milliseconds)") +RULE_BOOL(NPC, UseItemBonusesForNonPets, true, "Switch whether item bonuses should be used for NPCs who are not pets") +RULE_BOOL(NPC, UseBaneDamage, false, "If NPCs can't inheriently hit the target we don't add bane/magic dmg which isn't exactly the same as PCs") +RULE_INT(NPC, SayPauseTimeInSec, 5, "Time span in which an NPC pauses his movement after a Say event without aggro (seconds)") +RULE_INT(NPC, OOCRegen, 0, "Enable out-of-combat regeneration for NPC") +RULE_BOOL(NPC, BuffFriends, false, "Setting whether NPC should buff other NPC") +RULE_BOOL(NPC, EnableNPCQuestJournal, false, "Setting whether the NPC Quest Journal is active") +RULE_INT(NPC, LastFightingDelayMovingMin, 10000, "Minimum time before mob goes home after all aggro loss (milliseconds)") +RULE_INT(NPC, LastFightingDelayMovingMax, 20000, "Maximum time before mob goes home after all aggro loss (milliseconds)") +RULE_BOOL(NPC, SmartLastFightingDelayMoving, true, "When true, mobs that started going home previously will do so again immediately if still on FD hate list") +RULE_BOOL(NPC, ReturnNonQuestNoDropItems, false, "Returns NO DROP items on NPCthat don't have an EVENT_TRADE sub in their script") +RULE_INT(NPC, StartEnrageValue, 9, " Percentage HP that an NPC will begin to enrage") RULE_BOOL(NPC, LiveLikeEnrage, false, "If set to true then only player controlled pets will enrage") RULE_BOOL(NPC, EnableMeritBasedFaction, false, "If set to true, faction will given in the same way as experience (solo/group/raid)") -RULE_INT(NPC, NPCToNPCAggroTimerMin, 500, "") -RULE_INT(NPC, NPCToNPCAggroTimerMax, 6000, "") -RULE_BOOL(NPC, UseClassAsLastName, true, "Uses class archetype as LastName for npcs with none") +RULE_INT(NPC, NPCToNPCAggroTimerMin, 500, "Minimum time span after which one NPC aggro another NPC (milliseconds)") +RULE_INT(NPC, NPCToNPCAggroTimerMax, 6000, "Maximum time span after which one NPC aggro another NPC (milliseconds)") +RULE_BOOL(NPC, UseClassAsLastName, true, "Uses class archetype as LastName for NPCwith none") RULE_BOOL(NPC, NewLevelScaling, true, "Better level scaling, use old if new formulas would break your server") -RULE_INT(NPC, NPCGatePercent, 20, "% at which the NPC Will attempt to gate at") +RULE_INT(NPC, NPCGatePercent, 20, " Percentage at which the NPC Will attempt to gate at") RULE_BOOL(NPC, NPCGateNearBind, false, "Will NPC attempt to gate when near bind location?") RULE_INT(NPC, NPCGateDistanceBind, 75, "Distance from bind before NPC will attempt to gate") RULE_BOOL(NPC, NPCHealOnGate, true, "Will the NPC Heal on Gate") @@ -534,48 +530,47 @@ RULE_REAL(NPC, NPCHealOnGateAmount, 25, "How much the npc will heal on gate if e RULE_CATEGORY_END() RULE_CATEGORY(Aggro) -RULE_BOOL(Aggro, SmartAggroList, true, "") -RULE_INT(Aggro, SittingAggroMod, 35, "35%") -RULE_INT(Aggro, MeleeRangeAggroMod, 10, "10%") -RULE_INT(Aggro, CurrentTargetAggroMod, 0, "0% -- will prefer our current target to any other; makes it harder for our npcs to switch targets") -RULE_INT(Aggro, CriticallyWoundedAggroMod, 100, "100%") -RULE_INT(Aggro, SpellAggroMod, 100, "") -RULE_INT(Aggro, SongAggroMod, 33, "") -RULE_INT(Aggro, PetSpellAggroMod, 10, "") -RULE_REAL(Aggro, TunnelVisionAggroMod, 0.75, "people not currently the top hate generate this much hate on a Tunnel Vision mob") -RULE_INT(Aggro, MaxScalingProcAggro, 400, "Set to -1 for no limit. Maxmimum amount of aggro that HP scaling SPA effect in a proc will add") -RULE_INT(Aggro, IntAggroThreshold, 75, "Int <= this will aggro regardless of level difference") +RULE_BOOL(Aggro, SmartAggroList, true, "Smart aggro list attempts to choose targets in a much smarter fashion, prefering players to pets, sitting and critically injured players to normal players, and players in melee range to players not") +RULE_INT(Aggro, SittingAggroMod, 35, "Aggro increase against sitting targets. 35=35%") +RULE_INT(Aggro, MeleeRangeAggroMod, 10, "Aggro increase against targets in melee range. 10=10%") +RULE_INT(Aggro, CurrentTargetAggroMod, 0, "Aggro increase against current target. 0% = prefer the current target to any other. Makes it harder for our NPCto switch targets") +RULE_INT(Aggro, CriticallyWoundedAggroMod, 100, "Aggro increase against critical wounded targets") +RULE_INT(Aggro, SpellAggroMod, 100, "Aggro increase for spells") +RULE_INT(Aggro, SongAggroMod, 33, "Aggro increase for songs") +RULE_INT(Aggro, PetSpellAggroMod, 10, "Aggro increase for pet spells") +RULE_REAL(Aggro, TunnelVisionAggroMod, 0.75, "People not currently the top hate generate this much hate on a Tunnel Vision mob") +RULE_INT(Aggro, MaxScalingProcAggro, 400, "Set to -1 for no limit. Maximum amount of aggro that HP scaling SPA effect in a proc will add") +RULE_INT(Aggro, IntAggroThreshold, 75, "Int lesser or equal the value will aggro regardless of level difference") RULE_BOOL(Aggro, AllowTickPulling, false, "tick pulling is an exploit in an NPC's call for help fixed sometime in 2006 on live") -RULE_INT(Aggro, MinAggroLevel, 18, "For use with UseLevelAggro") -RULE_BOOL(Aggro, UseLevelAggro, true, "MinAggroLevel rule value+ and Undead will aggro regardless of level difference. (this will disabled Rule:IntAggroThreshold if set to true)") +RULE_INT(Aggro, MinAggroLevel, 18, "Minimum level for use with UseLevelAggro") +RULE_BOOL(Aggro, UseLevelAggro, true, "MinAggroLevel rule value+ and Undead will aggro regardless of level difference. This will disabled Rule:IntAggroThreshold if set to true") RULE_INT(Aggro, ClientAggroCheckInterval, 6, "Interval in which clients actually check for aggro - in seconds") -RULE_REAL(Aggro, PetAttackRange, 40000.0, "max squared range /pet attack works at default is 200") +RULE_REAL(Aggro, PetAttackRange, 40000.0, "Maximum squared range /pet attack works at default is 200") RULE_BOOL(Aggro, NPCAggroMaxDistanceEnabled, true, "If enabled, NPC's will drop aggro beyond 600 units or what is defined at the zone level") RULE_CATEGORY_END() RULE_CATEGORY(TaskSystem) RULE_BOOL(TaskSystem, EnableTaskSystem, true, "Globally enable or disable the Task system") RULE_INT(TaskSystem, PeriodicCheckTimer, 5, "Seconds between checks for failed tasks. Also used by the 'Touch' activity") -RULE_BOOL(TaskSystem, RecordCompletedTasks, true, "") -RULE_BOOL(TaskSystem, RecordCompletedOptionalActivities, false, "") -RULE_BOOL(TaskSystem, KeepOneRecordPerCompletedTask, true, "") -RULE_BOOL(TaskSystem, EnableTaskProximity, true, "") +RULE_BOOL(TaskSystem, RecordCompletedTasks, true, "Record completed tasks") +RULE_BOOL(TaskSystem, RecordCompletedOptionalActivities, false, "Record completed optional activities") +RULE_BOOL(TaskSystem, KeepOneRecordPerCompletedTask, true, "Keep only one record per completed task") +RULE_BOOL(TaskSystem, EnableTaskProximity, true, "Enable task proximity system") RULE_CATEGORY_END() RULE_CATEGORY(Range) -RULE_INT(Range, Say, 15, "") -RULE_INT(Range, Emote, 135, "") -RULE_INT(Range, BeginCast, 200, "") -RULE_INT(Range, Anims, 135, "") -RULE_INT(Range, SpellParticles, 135, "") -RULE_INT(Range, DamageMessages, 50, "") -RULE_INT(Range, SpellMessages, 75, "") -RULE_INT(Range, SongMessages, 75, "") -RULE_INT(Range, MobPositionUpdates, 600, "") -RULE_INT(Range, ClientPositionUpdates, 300, "") -RULE_INT(Range, ClientForceSpawnUpdateRange, 1000, "") -RULE_INT(Range, CriticalDamage, 80, "") -RULE_INT(Range, MobCloseScanDistance, 600, "") +RULE_INT(Range, Say, 15, "The range that is required before /say or hail messages will work to an NPC") +RULE_INT(Range, Emote, 135, "The packet range in which emote messages are sent'") +RULE_INT(Range, BeginCast, 200, "The packet range in which begin cast messages are sent") +RULE_INT(Range, Anims, 135, "The packet range in which begin cast messages are sent") +RULE_INT(Range, SpellParticles, 135, "The packet range in which spell particles are sent") +RULE_INT(Range, DamageMessages, 50, "The packet range in which damage messages are sent (non-crit)") +RULE_INT(Range, SpellMessages, 75, "The packet range in which spell damage messages are sent") +RULE_INT(Range, SongMessages, 75, "The packet range in which song messages are sent") +RULE_INT(Range, MobPositionUpdates, 600, "The packet range in which mob position updates are sent") +RULE_INT(Range, ClientPositionUpdates, 300, "Distance in which the own changed position is communicated to other clients") +RULE_INT(Range, CriticalDamage, 80, "The packet range in which critical hit messages are sent") +RULE_INT(Range, MobCloseScanDistance, 600, "Close scan distance") RULE_CATEGORY_END() @@ -583,7 +578,7 @@ RULE_CATEGORY_END() RULE_CATEGORY(Bots) RULE_INT(Bots, BotExpansionSettings, 16383, "Sets the expansion settings for bot use. Defaults to all expansions enabled up to TSS") RULE_BOOL(Bots, AllowCamelCaseNames, false, "Allows the use of 'MyBot' type names") -RULE_INT(Bots, CommandSpellRank, 1, "Filters bot command spells by rank (1, 2 and 3 are valid filters - any other number allows all ranks)") +RULE_INT(Bots, CommandSpellRank, 1, "Filters bot command spells by rank. 1, 2 and 3 are valid filters - any other number allows all ranks") RULE_INT(Bots, CreationLimit, 150, "Number of bots that each account can create") RULE_BOOL(Bots, FinishBuffing, false, "Allow for buffs to complete even if the bot caster is out of mana. Only affects buffing out of combat") RULE_BOOL(Bots, GroupBuffing, false, "Bots will cast single target buffs as group buffs, default is false for single. Does not make single target buffs work for MGB") @@ -593,14 +588,14 @@ RULE_REAL(Bots, ManaRegen, 2.0, "Adjust mana regen for bots, 1 is fast and highe RULE_BOOL(Bots, PreferNoManaCommandSpells, true, "Give sorting priority to newer no-mana spells (i.e., 'Bind Affinity')") RULE_BOOL(Bots, QuestableSpawnLimit, false, "Optional quest method to manage bot spawn limits using the quest_globals name bot_spawn_limit, see: /bazaar/Aediles_Thrall.pl") RULE_BOOL(Bots, QuestableSpells, false, "Anita Thrall's (Anita_Thrall.pl) Bot Spell Scriber quests") -RULE_INT(Bots, SpawnLimit, 71, "Number of bots a character can have spawned at one time, You + 71 bots is a 12 group pseudo-raid (bots are not raidable at this time)") +RULE_INT(Bots, SpawnLimit, 71, "Number of bots a character can have spawned at one time, You + 71 bots is a 12 group pseudo-raid") RULE_BOOL(Bots, UpdatePositionWithTimer, false, "Sends a position update with every positive movement timer check") RULE_BOOL(Bots, UsePathing, true, "Bots will use node pathing when moving") -RULE_BOOL(Bots, BotGroupXP, false, "Determines whether client gets xp for bots outside their group") +RULE_BOOL(Bots, BotGroupXP, false, "Determines whether client gets experience for bots outside their group") RULE_BOOL(Bots, BotBardUseOutOfCombatSongs, true, "Determines whether bard bots use additional out of combat songs (optional script)") RULE_BOOL(Bots, BotLevelsWithOwner, false, "Auto-updates spawned bots as owner levels/de-levels (false is original behavior)") RULE_BOOL(Bots, BotCharacterLevelEnabled, false, "Enables required level to spawn bots") -RULE_INT(Bots, BotCharacterLevel, 0, "0 as default (if level > this value you can spawn bots if BotCharacterLevelEnabled is true)") +RULE_INT(Bots, BotCharacterLevel, 0, "If level is greater that value player can spawn bots if BotCharacterLevelEnabled is true") RULE_INT(Bots, CasterStopMeleeLevel, 13, "Level at which caster bots stop melee attacks") RULE_INT(Bots, AllowedClasses, 0xFFFFFFFF, "Bitmask of allowed bot classes") RULE_INT(Bots, AllowedRaces, 0xFFFFFFFF, "Bitmask of allowed bot races") @@ -615,20 +610,20 @@ RULE_CATEGORY_END() #endif RULE_CATEGORY(Chat) -RULE_BOOL(Chat, ServerWideOOC, true, "") -RULE_BOOL(Chat, ServerWideAuction, true, "") -RULE_BOOL(Chat, EnableVoiceMacros, true, "") -RULE_BOOL(Chat, EnableMailKeyIPVerification, true, "") -RULE_BOOL(Chat, EnableAntiSpam, true, "") -RULE_BOOL(Chat, SuppressCommandErrors, false, "Do not suppress by default") -RULE_INT(Chat, MinStatusToBypassAntiSpam, 100, "") -RULE_INT(Chat, MinimumMessagesPerInterval, 4, "") -RULE_INT(Chat, MaximumMessagesPerInterval, 12, "") -RULE_INT(Chat, MaxMessagesBeforeKick, 20, "") -RULE_INT(Chat, IntervalDurationMS, 60000, "") -RULE_INT(Chat, KarmaUpdateIntervalMS, 1200000, "") -RULE_INT(Chat, KarmaGlobalChatLimit, 72, "amount of karma you need to be able to talk in ooc/auction/chat below the level limit") -RULE_INT(Chat, GlobalChatLevelLimit, 8, "level limit you need to of reached to talk in ooc/auction/chat if your karma is too low") +RULE_BOOL(Chat, ServerWideOOC, true, "Enable server wide ooc-chat") +RULE_BOOL(Chat, ServerWideAuction, true, "Enable server wide auction-chat") +RULE_BOOL(Chat, EnableVoiceMacros, true, "Enable voice macros") +RULE_BOOL(Chat, EnableMailKeyIPVerification, true, "Setting whether the authenticity of the client should be verified via its IP address when accessing the InGame mailbox") +RULE_BOOL(Chat, EnableAntiSpam, true, "Enable anti-spam system for chat") +RULE_BOOL(Chat, SuppressCommandErrors, false, "Do not suppress command errors by default") +RULE_INT(Chat, MinStatusToBypassAntiSpam, 100, "Minimum status to bypass the anti spam system") +RULE_INT(Chat, MinimumMessagesPerInterval, 4, "Minimum number of chat messages allowed per interval. The karma value is added to this value") +RULE_INT(Chat, MaximumMessagesPerInterval, 12, "Maximum value of chat messages allowed per interval") +RULE_INT(Chat, MaxMessagesBeforeKick, 20, "If an attempt is made to send more than the maximum allowed number of chat messages per interval, the client will be disconnected after this absolute number of messages") +RULE_INT(Chat, IntervalDurationMS, 60000, "Interval length in milliseconds") +RULE_INT(Chat, KarmaUpdateIntervalMS, 1200000, "Karma update interval in milliseconds") +RULE_INT(Chat, KarmaGlobalChatLimit, 72, "Amount of karma you need to be able to talk in ooc/auction/chat below the level limit") +RULE_INT(Chat, GlobalChatLevelLimit, 8, "Level limit you need to of reached to talk in ooc/auction/chat if your karma is too low") RULE_CATEGORY_END() RULE_CATEGORY(Merchant) @@ -640,21 +635,21 @@ RULE_INT(Merchant, PricePenaltyPct, 4, "Determines maximum price penalty from ha RULE_REAL(Merchant, ChaBonusMod, 3.45, "Determines CHA cap, from 104 CHA. 3.45 is 132 CHA at apprehensive. 0.34 is 400 CHA at apprehensive") RULE_REAL(Merchant, ChaPenaltyMod, 1.52, "Determines CHA bottom, up to 102 CHA. 1.52 is 37 CHA at apprehensive. 0.98 is 0 CHA at apprehensive") RULE_BOOL(Merchant, EnableAltCurrencySell, true, "Enables the ability to resell items to alternate currency merchants") -RULE_BOOL(Merchant, AllowCorpse, false, "Can merchants generate a corpse") +RULE_BOOL(Merchant, AllowCorpse, false, "Setting whether dealers leave a corpse behind ") RULE_CATEGORY_END() RULE_CATEGORY(Bazaar) -RULE_BOOL(Bazaar, AuditTrail, false, "") -RULE_INT(Bazaar, MaxSearchResults, 50, "") -RULE_BOOL(Bazaar, EnableWarpToTrader, true, "") -RULE_INT(Bazaar, MaxBarterSearchResults, 200, "The max results returned in the /barter search") +RULE_BOOL(Bazaar, AuditTrail, false, "Setting whether a path to the trader should be displayed in the bazaar") +RULE_INT(Bazaar, MaxSearchResults, 50, "Maximum number of search results in Bazaar") +RULE_BOOL(Bazaar, EnableWarpToTrader, true, "Setting whether teleport to the selected trader should be active") +RULE_INT(Bazaar, MaxBarterSearchResults, 200, "The maximum results returned in the /barter search") RULE_CATEGORY_END() RULE_CATEGORY(Mail) -RULE_BOOL(Mail, EnableMailSystem, true, "If false, client won't bring up the Mail window") -RULE_INT(Mail, ExpireTrash, 0, "Time in seconds. 0 will delete all messages in the trash when the mailserver starts") -RULE_INT(Mail, ExpireRead, 31536000, "1 Year. Set to -1 for never") -RULE_INT(Mail, ExpireUnread, 31536000, "1 Year. Set to -1 for never") +RULE_BOOL(Mail, EnableMailSystem, true, "Setting whether the mail system is activated. If false, client won't bring up the Mail window") +RULE_INT(Mail, ExpireTrash, 0, "Setting when the mail trash is emptied. Time in seconds. 0 will delete all messages in the trash when the mailserver starts") +RULE_INT(Mail, ExpireRead, 31536000, "Setting when read mails expire. 31536000=1 Year. Set to -1 for never") +RULE_INT(Mail, ExpireUnread, 31536000, "Setting when unread mails expire. 31536000=1 Year. Set to -1 for never") RULE_CATEGORY_END() RULE_CATEGORY(Channels) @@ -669,30 +664,28 @@ RULE_BOOL(EventLog, RecordBuyFromMerchant, false, "Record purchases by a player RULE_CATEGORY_END() RULE_CATEGORY(Adventure) -RULE_INT(Adventure, MinNumberForGroup, 2, "") -RULE_INT(Adventure, MaxNumberForGroup, 6, "") -RULE_INT(Adventure, MinNumberForRaid, 18, "") -RULE_INT(Adventure, MaxNumberForRaid, 36, "") -RULE_INT(Adventure, MaxLevelRange, 9, "") -RULE_INT(Adventure, NumberKillsForBossSpawn, 45, "") -RULE_REAL(Adventure, DistanceForRescueAccept, 10000.0, "") -RULE_REAL(Adventure, DistanceForRescueComplete, 2500.0, "") -RULE_INT(Adventure, ItemIDToEnablePorts, 41000, "0 to disable, otherwise using a LDoN portal will require the user to have this item") -RULE_INT(Adventure, LDoNTrapDistanceUse, 625, "") -RULE_REAL(Adventure, LDoNBaseTrapDifficulty, 15.0, "") -RULE_REAL(Adventure, LDoNCriticalFailTrapThreshold, 10.0, "") -RULE_INT(Adventure, LDoNAdventureExpireTime, 1800, "30 minutes to expire") +RULE_INT(Adventure, MinNumberForGroup, 2, "Minimum members for adventure group") +RULE_INT(Adventure, MaxNumberForGroup, 6, "Maximum members for adventure group") +RULE_INT(Adventure, MaxLevelRange, 9, "Maximum level range for adventure") +RULE_INT(Adventure, NumberKillsForBossSpawn, 45, "Number of adventure kills to make the boss spawn") +RULE_REAL(Adventure, DistanceForRescueAccept, 10000.0, "Distance for adventure rescue accept") +RULE_REAL(Adventure, DistanceForRescueComplete, 2500.0, "Distance for adventure rescue complete") +RULE_INT(Adventure, ItemIDToEnablePorts, 41000, "ItemID to enable adventure ports. 0 to disable, otherwise using a LDoN portal will require the user to have this item") +RULE_INT(Adventure, LDoNTrapDistanceUse, 625, "LDoN trap distance use") +RULE_REAL(Adventure, LDoNBaseTrapDifficulty, 15.0, "LDoN base trap difficulty") +RULE_REAL(Adventure, LDoNCriticalFailTrapThreshold, 10.0, "LDoN critical fail trap threshold") +RULE_INT(Adventure, LDoNAdventureExpireTime, 1800, "LDoN adventure expire time (seconds)") RULE_CATEGORY_END() RULE_CATEGORY(AA) -RULE_INT(AA, ExpPerPoint, 23976503, "Amount of exp per AA. Is the same as the amount of exp to go from level 51 to level 52") +RULE_INT(AA, ExpPerPoint, 23976503, "Amount of experience per AA. Is the same as the amount of experience to go from level 51 to level 52") RULE_BOOL(AA, Stacking, true, "Allow AA that belong to the same group to stack on SOF+ clients") -RULE_BOOL(AA, NormalizedAAEnabled, false, "TSS+ change to AA that normalizes AA XP to a fixed # of white con kills independent of level") +RULE_BOOL(AA, NormalizedAAEnabled, false, "TSS+ change to AA that normalizes AA experience to a fixed # of white con kills independent of level") RULE_INT(AA, NormalizedAANumberOfWhiteConPerAA, 25, "The number of white con kills per AA point") -RULE_BOOL(AA, ModernAAScalingEnabled, false, "Are we linearly scaling AA XP based on total # of earned AA?") -RULE_REAL(AA, ModernAAScalingStartPercent, 1000, "1000% or 10x AA XP at the start of the scaling range") -RULE_INT(AA, ModernAAScalingAAMinimum, 0, "The minimum number of earned AA before AA XP scaling begins") -RULE_INT(AA, ModernAAScalingAALimit, 4000, "The number of earned AA when AA XP scaling ends") +RULE_BOOL(AA, ModernAAScalingEnabled, false, "Are we linearly scaling AA experience based on total # of earned AA?") +RULE_REAL(AA, ModernAAScalingStartPercent, 1000, "1000% or 10x AA experience at the start of the scaling range") +RULE_INT(AA, ModernAAScalingAAMinimum, 0, "The minimum number of earned AA before AA experience scaling begins") +RULE_INT(AA, ModernAAScalingAALimit, 4000, "The number of earned AA when AA experience scaling ends") RULE_CATEGORY_END() RULE_CATEGORY(Console) @@ -700,38 +693,38 @@ RULE_INT(Console, SessionTimeOut, 600000, "Amount of time in ms for the console RULE_CATEGORY_END() RULE_CATEGORY(Network) -RULE_INT(Network, ResendDelayBaseMS, 100, "") -RULE_REAL(Network, ResendDelayFactor, 1.5, "") -RULE_INT(Network, ResendDelayMinMS, 300, "") -RULE_INT(Network, ResendDelayMaxMS, 5000, "") +RULE_INT(Network, ResendDelayBaseMS, 100, "Base delay for resending data in EQStreamManager (milliseconds)") +RULE_REAL(Network, ResendDelayFactor, 1.5, "Multiplier for the base delay when resending data in EQStreamManager") +RULE_INT(Network, ResendDelayMinMS, 300, "Minimum timespan between two send retries (milliseconds)") +RULE_INT(Network, ResendDelayMaxMS, 5000, "Maximum timespan between two send retries (milliseconds)") RULE_REAL(Network, ClientDataRate, 0.0, "KB / sec, 0.0 disabled") -RULE_BOOL(Network, CompressZoneStream, true, "") +RULE_BOOL(Network, CompressZoneStream, true, "Setting whether the zone stream should be compressed for transmission") RULE_CATEGORY_END() RULE_CATEGORY(QueryServ) -RULE_BOOL(QueryServ, PlayerLogChat, false, "Logs Player Chat") -RULE_BOOL(QueryServ, PlayerLogTrades, false, "Logs Player Trades") -RULE_BOOL(QueryServ, PlayerDropItems, false, "Logs Player dropping items") -RULE_BOOL(QueryServ, PlayerLogHandins, false, "Logs Player Handins") -RULE_BOOL(QueryServ, PlayerLogNPCKills, false, "Logs Player NPC Kills") -RULE_BOOL(QueryServ, PlayerLogDeletes, false, "Logs Player Deletes") -RULE_BOOL(QueryServ, PlayerLogMoves, false, "Logs Player Moves") -RULE_BOOL(QueryServ, PlayerLogMerchantTransactions, false, "Logs Merchant Transactions") -RULE_BOOL(QueryServ, PlayerLogPCCoordinates, false, "Logs Player Coordinates with certain events") -RULE_BOOL(QueryServ, PlayerLogDropItem, false, "Logs Player Drop Item") -RULE_BOOL(QueryServ, PlayerLogZone, false, "Logs Player Zone Events") -RULE_BOOL(QueryServ, PlayerLogDeaths, false, "Logs Player Deaths") -RULE_BOOL(QueryServ, PlayerLogConnectDisconnect, false, "Logs Player Connect Disconnect State") -RULE_BOOL(QueryServ, PlayerLogLevels, false, "Logs Player Leveling/Deleveling") -RULE_BOOL(QueryServ, PlayerLogAARate, false, "Logs Player AA Experience Rates") -RULE_BOOL(QueryServ, PlayerLogQGlobalUpdate, false, "Logs Player QGlobal Updates") -RULE_BOOL(QueryServ, PlayerLogTaskUpdates, false, "Logs Player Task Updates") -RULE_BOOL(QueryServ, PlayerLogKeyringAddition, false, "Log PLayer Keyring additions") -RULE_BOOL(QueryServ, PlayerLogAAPurchases, false, "Log Player AA Purchases") -RULE_BOOL(QueryServ, PlayerLogTradeSkillEvents, false, "Log Player Tradeskill Transactions") -RULE_BOOL(QueryServ, PlayerLogIssuedCommandes, false, "Log Player Issued Commands") -RULE_BOOL(QueryServ, PlayerLogMoneyTransactions, false, "Log Player Money Transaction/Splits") -RULE_BOOL(QueryServ, PlayerLogAlternateCurrencyTransactions, false, "Log Player Alternate Currency Transactions") +RULE_BOOL(QueryServ, PlayerLogChat, false, "Log player chat") +RULE_BOOL(QueryServ, PlayerLogTrades, false, "Log player trades") +RULE_BOOL(QueryServ, PlayerDropItems, false, "Log player dropping items") +RULE_BOOL(QueryServ, PlayerLogHandins, false, "Log player handins") +RULE_BOOL(QueryServ, PlayerLogNPCKills, false, "Log player NPC kills") +RULE_BOOL(QueryServ, PlayerLogDeletes, false, "Log player deletes") +RULE_BOOL(QueryServ, PlayerLogMoves, false, "Log player moves") +RULE_BOOL(QueryServ, PlayerLogMerchantTransactions, false, "Log merchant transactions") +RULE_BOOL(QueryServ, PlayerLogPCCoordinates, false, "Log player coordinates with certain events") +RULE_BOOL(QueryServ, PlayerLogDropItem, false, "Log player drop item") +RULE_BOOL(QueryServ, PlayerLogZone, false, "Log player zone events") +RULE_BOOL(QueryServ, PlayerLogDeaths, false, "Log player deaths") +RULE_BOOL(QueryServ, PlayerLogConnectDisconnect, false, "Logs player connect/disconnect state") +RULE_BOOL(QueryServ, PlayerLogLevels, false, "Log player leveling/deleveling") +RULE_BOOL(QueryServ, PlayerLogAARate, false, "Log player AA experience rates") +RULE_BOOL(QueryServ, PlayerLogQGlobalUpdate, false, "Log player QGlobal updates") +RULE_BOOL(QueryServ, PlayerLogTaskUpdates, false, "Log player Task updates") +RULE_BOOL(QueryServ, PlayerLogKeyringAddition, false, "Log player keyring additions") +RULE_BOOL(QueryServ, PlayerLogAAPurchases, false, "Log player AA purchases") +RULE_BOOL(QueryServ, PlayerLogTradeSkillEvents, false, "Log player tradeskill transactions") +RULE_BOOL(QueryServ, PlayerLogIssuedCommandes, false, "Log player issued commands") +RULE_BOOL(QueryServ, PlayerLogMoneyTransactions, false, "Log player money transaction/splits") +RULE_BOOL(QueryServ, PlayerLogAlternateCurrencyTransactions, false, "Log player alternate currency transactions") RULE_CATEGORY_END() RULE_CATEGORY(Inventory) @@ -744,8 +737,8 @@ RULE_BOOL(Inventory, TransformSummonedBags, false, "Transforms summoned bags int RULE_CATEGORY_END() RULE_CATEGORY(Client) -RULE_BOOL(Client, UseLiveFactionMessage, false, "Allows players to see faction adjustments like Live") -RULE_BOOL(Client, UseLiveBlockedMessage, false, "Allows players to see faction adjustments like Live") +RULE_BOOL(Client, UseLiveFactionMessage, false, "Allows players to see detailed faction adjustments as on the live servers") +RULE_BOOL(Client, UseLiveBlockedMessage, false, "Setting whether detailed spell block messages should be used as on the live servers") RULE_CATEGORY_END() RULE_CATEGORY(Bugs) @@ -755,14 +748,14 @@ RULE_BOOL(Bugs, DumpTargetEntity, false, "Dumps the target entity, if one is pro RULE_CATEGORY_END() RULE_CATEGORY(Faction) -RULE_INT(Faction, AllyFactionMinimum, 1100, "") -RULE_INT(Faction, WarmlyFactionMinimum, 750, "") -RULE_INT(Faction, KindlyFactionMinimum, 500, "") -RULE_INT(Faction, AmiablyFactionMinimum, 100, "") -RULE_INT(Faction, IndifferentlyFactionMinimum, 0, "") -RULE_INT(Faction, ApprehensivelyFactionMinimum, -100, "") -RULE_INT(Faction, DubiouslyFactionMinimum, -500, "") -RULE_INT(Faction, ThreateninglyFactionMinimum, -750, "") +RULE_INT(Faction, AllyFactionMinimum, 1100, "Minimum faction for ally") +RULE_INT(Faction, WarmlyFactionMinimum, 750, "Minimum faction for warmly") +RULE_INT(Faction, KindlyFactionMinimum, 500, "Minimum faction for kindly") +RULE_INT(Faction, AmiablyFactionMinimum, 100, "Minimum faction for amiably") +RULE_INT(Faction, IndifferentlyFactionMinimum, 0, "Minimum faction for indifferently") +RULE_INT(Faction, ApprehensivelyFactionMinimum, -100, "Minimum faction for apprehensively") +RULE_INT(Faction, DubiouslyFactionMinimum, -500, "Minimum faction for dubiously") +RULE_INT(Faction, ThreateninglyFactionMinimum, -750, "Minimum faction for threateningly") RULE_CATEGORY_END() RULE_CATEGORY(Logging) @@ -776,8 +769,8 @@ RULE_BOOL(HotReload, QuestsResetTimersWithReload, true, "When a hot reload is tr RULE_CATEGORY_END() RULE_CATEGORY(Instances) -RULE_INT(Instances, ReservedInstances, 30, "Will reserve this many instance ids for globals... probably not a good idea to change this while a server is running") -RULE_BOOL(Instances, RecycleInstanceIds, true, "Will recycle free instance ids instead of gradually running out at 32k") +RULE_INT(Instances, ReservedInstances, 30, "Number of instance IDs which are reserved for globals. This value should not be changed while a server is running") +RULE_BOOL(Instances, RecycleInstanceIds, true, "Setting whether free instance IDs should be recycled to prevent them from gradually running out at 32k") RULE_INT(Instances, GuildHallExpirationDays, 90, "Amount of days before a Guild Hall instance expires") RULE_CATEGORY_END()