POL Configuration Files

OnMount
{
    [(int normal animation) (int mounted animation)]...
}

MobileType (string type)
{
    [OldAnimX (int action) [int framecount {default 5}] [int repeatcount {default 5}] [int backward {default 0}] [int repeatflag {default 0}] [int delay {default 1}]
    [NewAnim (int anim) [int action {default 0}] [int subaction {default 0}]
    [Graphic (int graphic)]
}

ArmorZone
{
    Name    (string zone name)
    Chance  (int chance to hit)
    [Layer  (int UO client layer)]...
}
[ArmorZone...]

Attribute (Attribute_Name)
{
    [Alias                      (Alias_Name)]...
    [GetIntrinsicModFunction    (script_name:exported_func_name)]
    [Delay                      (Skill Delay for skills with buttons on Skill Window)]
    [Unhides                    (Unhides on skill use (0/1)]
    [Script                     (Location of script for skills with buttons on Skill Window)]
    [DefaultCap                 (cap in tenth of attribute {default ssopt:DefaultAttributeCap}]
    [DisableCoreChecks          (0/1 {default 0}]
}
[Attribute...]

AuxService
{
    Port     (intger port)
    Script   (string script filename)
    [IPMatch (IPaddress)[/(netmask)]]
}

BannedIP
{
    IPMatch (IPaddress)[/(netmask)]
}
[BannedIP...]

Boat
{
    MultiId                     (int boat multi id)
    TillerMan                   (int item graphic) (x offset) (y offset)
    PortGangplankExtended       (int item graphic) (x offset) (y offset)
    PortGangplankRetracted      (int item graphic) (x offset) (y offset)
    StarboardGangplankExtended  (int item graphic) (x offset) (y offset)
    StarboardGangplankRetracted (int item graphic) (x offset) (y offset)
    Hold                        (int item graphic) (x offset) (y offset)
    [Rope                       (int item graphic) (x offset) (y offset)]
    [Wheel                      (int item graphic) (x offset) (y offset)]
    [Hull                       (int item graphic) (x offset) (y offset)]
    [Tiller                     (int item graphic) (x offset) (y offset)]
    [Rudder                     (int item graphic) (x offset) (y offset)]
    [Sails                      (int item graphic) (x offset) (y offset)]
    [Storage                    (int item graphic) (x offset) (y offset)]
    [WeaponSlot                 (int item graphic) (x offset) (y offset)]
}
[Boat...]

Circle (int number)
{
    Mana        (int manacost)
    Difficulty  (int spell difficulty)
    PointValue  (int skill gain value)
    Delay       (int second casting delay)
}
[Circle...]

CmdLevel (cmdlevel name)
{
    DIR   (string path to this cmdlevel's textcmd directory)
    [DIR...]
    Alias (string alias name for this cmdlevel)
    [Alias...]
}
[CmdLevel...] {each successive element is one level higher than the last}

[DisplayParrySuccessMessages (0/1) {default 0})]
[WarmodeInhibitsRegen        (enumeration between 0-4) {default 0})]
[WarModeDelay                (int Seconds) {default 1})]
[SingleCombat                (0/1 {default 0})]
[CoreHitSounds               (0/1 {default 0})]
[ScriptedAttackChecks        (0/1 {default 0})]
[ResetSwingOnTurn            (0/1 {default 0})]
[SendSwingPacket             (0/1 {default 1})]
[SendDamagePacket            (0/1 {default 0})]
[AttackWhileFrozen           (0/1 {default 1})]
[SendAttackMsg               (0/1 {default 1})]

Commands
{
    [CMD  (letter)  (script) [(description}]]
    [CMD...]
}

ModuleDirectory (path to .em files)
IncludeDirectory (path to parent dir of non-packaged includes)
PolScriptRoot (path to non-packaged scripts)
PackageRoot (path to package root)
[PackageRoot...]
[GenerateListing (0/1 {default 0})]
[GenerateDebugInfo  (0/1 {default 0})]
[GenerateDebugTextInfo (0/1 {default 0})]
[DisplayWarnings (0/1 {default 0})]           //same as -w flag
[CompileAspPages (0/1 {default 0})]           //same as -a flag
[OnlyCompileUpdatedScripts (0/1 {default 0})] //same as -u flag
[WatchModeByDefault (0/1 {default 0})]        //Keep ecompile running to re-compile files that have changed.
[GenerateDependencyInfo (0/1 {default 0})]    //Generate .dep files whether or not updating
[DisplayUpToDateScripts (0/1 {default 0})]    //Display the "xxx/script.ecl is up-to-date" message, or not.
[AutoCompileByDefault (0/1 {default 0})]      //If set, and you don't pass any script names or -r or -A,
                                              //will perform an auto compile.
[UpdateOnlyOnAutoCompile (0/1 {default 0})]   //If set, autocompile will only update modified scripts.
[DisplaySummary (0/1 {default 0})]            //Displays overall totals after compilation, unless compilation
                                              //aborted due to a compile error.
[OptimizeObjectMembers (0/1 {default 1})]     //-m flag will set it to 0
[ErrorOnWarning (0/1 {default 0})]            //same as -y flag
[ThreadedCompilation (0/1 {default 0})]       //uses multiple thread to speed up compilation
[NumberOfThreads (0/N {default 0})]           //defines the used number of threads (0=autodetect)
[ParanoiaWarnings (0/1 {default 0})]          //will complain about {} syntax
[EmParseTreeCacheSize (0-N {default 25})]     //Cache parse trees for this number of *.em files
[IncParseTreeCacheSize (0-N {default 50})]    //Cache parse trees for this number of *.inc files

// Formatter Options (-F -Fi)
[FormatterLineWidth (0-N {default 80})]
[FormatterKeepKeywords (0/1 {default 0})]                  // keep original keyword spelling
[FormatterIdentLevel (0-N {default 2})]                    // number of spaces for ident
[FormatterMergeEmptyLines (0/1 {default 1})]               // multiple newlines get merged to a single
[FormatterEmptyParenthesisSpacing (0/1 {default 0})]       // space between emtpy parenthesis eg foo() vs foo( )
[FormatterEmptyBracketSpacing (0/1 {default 0})]           // space between emtpy brackets eg struct{} vs struct{ }
[FormatterConditionalParenthesisSpacing (0/1 {default 1})] // space after/before parenthesis in conditionals, eg if ( true ) vs if (true)
[FormatterParenthesisSpacing (0/1 {default 1})]            // space after/before parenthesis,eg foo( true ) vs foo(true)
[FormatterBracketSpacing (0/1 {default 1})]                // space after/before brackets,eg array{ true } vs array{true}
[FormatterDelimiterSpacing (0/1 {default 1})]              // add space after delimiter comma or semi in for loops, eg {1, 2, 3} vs {1,2,3}
[FormatterAssignmentSpacing (0/1 {default 1})]             // add space around assignment, eg a := 1; vs a:=1;
[FormatterComparisonSpacing (0/1 {default 1})]             // add space around comparison, eg a == 1 vs a==1
[FormatterOperatorSpacing (0/1 {default 1})]               // add space around operations, eg a + 1 vs a+1
[FormatterWindowsLineEndings (0/1 {default 0/1})]            // use \r\n (windows default) as newline instead of \n (default otherwise)
[FormatterUseTabs (0/1 {default 0})]                       // use tabs instead of spaces
[FormatterTabWidth (0-N {default 4})]
[FormatterInsertNewlineAtEOF (0/1 {default 0})]            // Insert a newline at end of file if missing

Equipment (templatename)
{
    [Armor  (item name or objtype) [(color)]]
    [Weapon (item name or objtype) [(color)]]
    [Equip  (item name or objtype) [(color)]]
}
[Equipment...]

[Tillerman                      (int objtype {default 0x1F010})]
[Port_Plank                     (int objtype {default 0x1F011})]
[Starboard_Plank                (int objtype {default 0x1F012})]
[Hold                           (int objtype {default 0x1F013})]
[Rope                           (int objtype {default 0x1F014})]
[Wheel                          (int objtype {default 0x1F015})]
[Hull                           (int objtype {default 0x1F016})]
[Tiller                         (int objtype {default 0x1F017})]
[Rudder                         (int objtype {default 0x1F018})]
[Sails                          (int objtype {default 0x1F019})]
[Storage                        (int objtype {default 0x1F01A})]
[Waponslot                      (int objtype {default 0x1F01B})]

[Wrestling                      (int objtype {default 0x1F020})]
[Mount                          (int objtype {default 0x1F021})]
[Shield                         (int objtype {default 0x1F022})]

[Secure_Trade_Container         (int objtype {default 0x1FF01})]
[Wornitems_Container            (int objtype {default 0x1FF02})]

FileAccess
{
  [Package (string package name, or *)]...
  [Directory (string directory name in pkg syntax, or *)]...
  [Extension (string file extension name, or *)]...
  [AllowRead (0/1 {default 0})]
  [AllowWrite (0/1 {default 0})]
  [AllowAppend (0/1 {default 0})]
  [AllowRemote (0/1 {default 0})]
}

(Class Name)  (integer unique 'objtype')
{
    (PropertyName)      (value)
    [PropertyName...]
}

Item (objtype)
{
    Name                    (string unique object name)
    [Name...]
    Graphic                 (int tile number)
    [Color                  (int color {default 0})]
    [Facing                 (int facing {default 0})]
    [Desc                   (string description {default empty})]
    [Tooltip                (string tooltip {default empty})]
    [WalkOnScript           (string scriptname)]
    [Script                 (string scriptname)]
    [SnoopScript            (string scriptname)]
    [EquipScript            (string scriptname)]
    [UnequipScript          (string scriptname)]
    [ControlScript          (string scriptname)]
    [CreateScript           (string scriptname)]
    [DestroyScript          (string scriptname)]
    [MethodScript           (string scriptname)]
    [RequiresAttention      (0/1 {default 1})]
    [Lockable               (0/1 {default 0})]
    [VendorSellsFor         (int gold {default 0})]
    [VendorBuysFor          (int gold {default 0})]
    [DecayTime              (int minutes {default servspecopt.cfg option})]
    [SaveOnExit             (0/1 {default 1})]
    [Movable                (0/1)]
    [DoubleClickRange       (int range {default servspecopt.cfg option})]
    [UseRequiresLOS         (0/1 {default 1})]
    [GhostsCanUse           (0/1 {default 0})]
    [CanUseWhileFrozen      (0/1 {default 0})]
    [CanUseWhileParalyzed   (0/1 {default 0})]
    [Newbie                 (0/1 {default 0})]
    [Insured                (0/1 {default 0})]
    [Cursed                 (0/1 {default 0})]
    [Invisible              (0/1 {default 0})]
    [DecaysOnMultis         (0/1 {default 0})]
    [BlocksCastingIfInHand  (0/1 {default 0})]
    [StrRequired            (int strength {default 0})]
    [MaxHP                  (int max {default 0})]
    [Weight                 (int weight {default tiledata value})]
    [OldObjtype             (int old objtype)]...
    [StackingIgnoresCProps  (propname1) [(propname2)]... ]
    [Resource               (string resource name) (int amount)]
    [Resource...]
    [FireResist             (int/(die-string value))]
    [ColdResist             (int/(die-string value))]
    [EnergyResist           (int/(die-string value))]
    [PoisonResist           (int/(die-string value))]
    [PhysicalResist         (int/(die-string value))]
    [FireDamage             (int/(die-string value))]
    [ColdDamage             (int/(die-string value))]
    [EnergyDamage           (int/(die-string value))]
    [PoisonDamage           (int/(die-string value))]
    [PhysicalDamage         (int/(die-string value))]

    [LowerReagentCost       (int/(die-string value))]
    [SpellDamageIncrease    (int/(die-string value))]
    [FasterCasting          (int/(die-string value))]
    [FasterCastRecovery     (int/(die-string value))]
    [DefenceIncrease        (int/(die-string value))]
    [DefenceIncreaseCap     (int/(die-string value))]
    [LowerManaCost          (int/(die-string value))]
    [HitChance              (int/(die-string value))]
    [FireResistCap          (int/(die-string value))]
    [ColdResistCap          (int/(die-string value))]
    [EnergyResistCap        (int/(die-string value))]
    [PhysicalResistCap      (int/(die-string value))]
    [PoisonResistCap        (int/(die-string value))]
    [Luck                   (int/(die-string value))]
    [SwingSpeedIncrease     (int/(die-string value))]

    [LowerReagentCostMod    (int/(die-string value))]
    [SpellDamageIncreaseMod (int/(die-string value))]
    [FasterCastingMod       (int/(die-string value))]
    [FasterCastRecoveryMod  (int/(die-string value))]
    [DefenceIncreaseMod     (int/(die-string value))]
    [DefenceIncreaseCapMod  (int/(die-string value))]
    [LowerManaCostMod       (int/(die-string value))]
    [HitChanceMod           (int/(die-string value))]
    [FireResistCapMod       (int/(die-string value))]
    [ColdResistCapMod       (int/(die-string value))]
    [EnergyResistCapMod     (int/(die-string value))]
    [PhysicalResistCapMod   (int/(die-string value))]
    [PoisonResistCapMod     (int/(die-string value))]
    [LuckMod                (int/(die-string value))]
    [SwingSpeedIncreaseMod  (int/(die-string value))]


    [StackLimit             (int {default 60000})]
    [NoDrop                 (0/1 {default 0})]

    [CProp                  (string name, string value, will set a CProp on the item at creation)]
    [Cprop                  (...)]

}

Container (objtype)
{
    {everything Item can have, plus: }
    Gump            (int gump graphic)
    MinX            (int gump pixel coordinate)
    MaxX            (int gump pixel coordinate)
    MinY            (int gump pixel coordinate)
    MaxY            (int gump pixel coordinate)
    [MaxWeight      (int weight {default to servspecopt.cfg})]
    [MaxItems       (int number {default to servspecopt.cfg})]
    [MaxSlots       (int 1-255 {default to servspecopt.cfg})]
    [NoDropException    (0/1 {default 0})]
    [CanInsertScript    (string scriptname)]
    [OnInsertScript     (string scriptname)]
    [CanRemoveScript    (string scriptname)]
    [OnRemoveScript     (string scriptname)]
}

Spellbook (objtype)
{
    {everything Container can have, plus: }
    SpellType  (string {"Magic", "Paladin", "Necro", "Bushido", "Ninjitsu" or "SpellWeaving"})
}

Door (objtype)
{
    {everything Item can have, plus: }
    OpenGraphic    (int tile number, graphic when door is opened)
    XMod            (int x modification when door toggled)
    YMod            (int y modification when door toggled)
}

House (objtype)
{
    {everything Item can have, plus: }
    MultiID         (int multiID number for this house)
}

Boat (objtype)
{
    {everything Item can have, plus: }
    MultiID           (int multiID number for this boat)
    AlternateMultiID  (int multiID number for alternative shape of boat, multiple can be supplied in order)
}

Map (objtype)
{
    {everything Item can have, plus: }
    Editable        (0/1 {default 1})]
}

Weapon (objtype)
{
    {everything Item can have, plus: }
    Speed            (int weapon attack speed)
    [Delay           (int weapon delay in ms {default 0})]
    Damage           (die-string value)
    Attribute        (string attribute name for skill this weapon requires)
    [Anim            (int animation ID number for attack {default 0x9})]
    [MountedAnim     (int animationID on mount {defaults to value in animxlate.cfg})]
    [HitSound        (int soundID)]
    [MissSound       (int soundID)]
    [HitScript       (string script name)]
    MaxHP            (int max)

    [Projectile      (0/1 {default 0})]
    [ProjectileType  (int objtype of projectile)]
    [ProjectileAnim  (int tile number of animation)]
    [ProjectileSound (int soundID for projectile shoot)]

    [TwoHanded       (0/1 {default 0})]
    [MinRange        (int minimum range to attack {default 2 if projectile weapon, 0 else})]
    [MaxRange        (int maximum range to attack {default 20 if projectile weapon, 1 else})]
}

Armor (objtype)
{
    {everything Item can have, plus: }
    AR               (int armor rating)
    MaxHP            (int max)
    [OnHitScript     (string script name)]
    [Coverage        (string armor zone name {defaults to layer number zone})]
    [Coverage...]
}

...and lots of any of these in the file...

Region (region name)
{
    Range        (x-west) (y-north) (x-east) (y-south)
    [Realm       (string realmname {default "britannia"})]
    [Guarded     (0/1 {default 0})]
    [EnterText   (string message)]
    [LeaveText   (string message)]
    [EnterScript (string script)]
    [LeaveScript (string script)]
}
[Region...]

Region (region name)
{
    Range        (x-west) (y-north) (x-east) (y-south)
    [Realm       (string realmname {default "britannia"})]
    [LightLevel       (int light level {default 0}]
}
[Region...]

ItemMenu
{
    Name        (string unique name)
    Title       (string title to show on menu)
    Entry       (objtype number to show)   (string description)
    [Entry...]
    [SubMenu    (string menuname) (objtype number to show)    (Description Of SubMenu)]
    [SubMenu...]
}
[ItemMenu...]

MovementCost
{
    [(integer percent max carried)   (real multiplier for movement)]...
    [Over                            (real multiplier for movement if over maximum)]
}

-or-

Walking
{
    {same as above}
}
Running
{
    {same as above}
}
[Walking_Mounted
{
    {same as above}
}]
[Running_Mounted
{
    {same as above}
}]

House (int multid)
{
    [static  (objtype) (xoffset) (yoffset) (zoffset)]
    [dynamic (objtype) (xoffset) (yoffset) (zoffset)]
}
[House...]

Boat (int multid)
{
    [static  (objtype) (xoffset) (yoffset) (zoffset)]
    [dynamic (objtype) (xoffset) (yoffset) (zoffset)]
}
[Boat...]

Stairs (int multid)
{
    [static  (objtype) (xoffset) (yoffset) (zoffset)]
    [dynamic (objtype) (xoffset) (yoffset) (zoffset)]
}
[Stairs...]

Region (region name)
{
    Range        (x-west) (y-north) (x-east) (y-south)
    [Realm       (string realmname {default "britannia"})]
    [Midi        (int music number)]
}
[Region...]

Region (region name)
{
    Range        (x-west) (y-north) (x-east) (y-south)
    [Realm       (string realmname {default "britannia"})]
    [Nocast      (0/1 {default 0})]
}
[Region...]

NpcTemplate (string unique templatename)
{
    Name                   (string paperdoll name)
    ObjType                (integer body model type)
    Script                 (string AI script)
    Gender                 (0=male 1=female)
    TrueColor              (int original body skin color)
    Color                  (int current body skin color)
    AR                     (die-string natural armor rating)
    [FireResist]           (int/die-string)]
    [ColdResist]           (int/die-string)]
    [EnergyResist]         (int/die-string)]
    [PoisonResist]         (int/die-string)]
    [PhysicalResist]       (int/die-string)]
    Alignment              ('good' 'neutral' or 'evil)

    [(VitalName)           (die-string value)]
    [VitalName...]

    [(AttributeName)       (die-string value)]
    [AttributeName...]

    // Intrinsic weapon creation
    [AttackSpeed            (int intrinsic weapon speed, weapon will be only created if this or AttackDelay is defined)]
    [AttackDelay           (int intrinsic weapon delay in ms, weapon will be only created if this or AttackSpeed is defined)]
    AttackDamage           (die-string damage for intrinsic weapon)
    AttackAttribute        (string attribute name used for intrinsic weapon)
    [AttackHitSound        (int sound ID for intrinsic weapon {default 0})]
    [AttackMissSound       (int sound ID for intrinsic weapon {default 0})]
    [AttackHitScript       (string script for intrinsic weapon hit)]
    [AttackMinRange        (int intrinsic weapon minimum range {default 0})]
    [AttackMaxRange        (int intrinsic weapon maximum range {default 0})]
    [AttackAnimation       (int animation ID {default 0 (wrestling)})]
    [AttackProjectile      (0/1 if defined, sets the intrinsic weapon as a projectile weapon]
    [AttackProjectileAnim  (int tile number of animation)]
    [AttackProjectileType  (int objtype of projectile)]
    [AttackProjectileSound (int soundID for projectile shoot)]
    [AttackCProp           (string name, string value, will set a CProp on the intrinsicn weapon)]
    [AttackCprop           (...)]

    // Intrinsic shield creation
    Shield                 (int intrinsic shield armor, no shield will be created if missing)
    [ShieldOnHitScript     (string script for intrinsic shield hit)]
    [ShieldCProp           (string name, string value, will set a CProp on the intrinsicn shield)]
    [ShieldCprop           (...)]

    [FireDamage]            (int/(die-string value))]
    [ColdDamage]            (int/(die-string value))]
    [EnergyDamage]          (int/(die-string value))]
    [PoisonDamage]          (int/(die-string value))]
    [PhysicalDamage]        (int/(die-string value))]

    [MaxHp                 (int maximum hitpoints for intrinsic weapon {default 1}]

    [MoveMode              (movemode string {default 'L'})]
    [Privs                 (string privilege) [(more privs)]...]
    [Settings              (string priv set 'on') [(more privs)]...]

    [SpeechColor           (int speech color {default 0x3B2})]
    [SpeechFont            (int speech color {default 3})]

    [UseAdjustments        (0/1 {default 1})]
    [RunSpeed              (int 0-250 {default dexterity})]
    [SaveOnExit            (0/1 {default 1})]
    [MethodScript          (string scriptname)]
    [NoDropException       (0/1 {default 0})]

    [LowerReagentCost       (int/(die-string value))]
    [SpellDamageIncrease    (int/(die-string value))]
    [FasterCasting          (int/(die-string value))]
    [FasterCastRecovery     (int/(die-string value))]
    [DefenceIncrease        (int/(die-string value))]
    [DefenceIncreaseCap     (int/(die-string value))]
    [LowerManaCost          (int/(die-string value))]
    [HitChance              (int/(die-string value))]
    [FireResistCap          (int/(die-string value))]
    [ColdResistCap          (int/(die-string value))]
    [EnergyResistCap        (int/(die-string value))]
    [PhysicalResistCap      (int/(die-string value))]
    [PoisonResistCap        (int/(die-string value))]
    [Luck                   (int/(die-string value))]
    [SwingSpeedIncrease     (int/(die-string value))]

    [LowerReagentCostMod    (int/(die-string value))]
    [SpellDamageIncreaseMod (int/(die-string value))]
    [FasterCastingMod       (int/(die-string value))]
    [FasterCastRecoveryMod  (int/(die-string value))]
    [DefenceIncreaseMod     (int/(die-string value))]
    [DefenceIncreaseCapMod  (int/(die-string value))]
    [LowerManaCostMod       (int/(die-string value))]
    [HitChanceMod           (int/(die-string value))]
    [FireResistCapMod       (int/(die-string value))]
    [ColdResistCapMod       (int/(die-string value))]
    [EnergyResistCapMod     (int/(die-string value))]
    [PhysicalResistCapMod   (int/(die-string value))]
    [PoisonResistCapMod     (int/(die-string value))]
    [LuckMod                (int/(die-string value))]
    [SwingSpeedIncreaseMod  (int/(die-string value))]

    [CProp                  (string name, string value, will set a CProp on the npc at creation)]
    [Cprop                  (...)]
}
[NpcTemplate...]

General
{
    //How many chars are allowed in a Party (normal clients only have 10 slots)
    [MaxPartyMembers int (default 10)]
    //Newer Clients (>=3.0.6e) does not automatically change "/# "
    //to private msg (they use "/t #")
    //set to true any public msg will be checked for "# " (0-9 0=slot 10)
    [TreatNoAsPrivate (1/0) (default 0)]
    //How long is an invite valid befor automatic decline
    //set to 0 disables the timeout
    [DeclineTimeout int seconds (default 10)]
    //Prefix for a private Msg (e.g. P:)
    [PrivateMsgPrefix string (default "")]
    //Member gets removed on logoff
    //if partyleader logoffs the next member becomes the leader
    [RemoveMemberOnLogoff (1/0) (default 0)]
    //rejoins party member on logon
    //RejoinPartyOnLogon is only used if RemoveMemberOnLogoff is true
    [RejoinPartyOnLogon (1/0) (default 0)]
}
HookList
{
    // CanAddToParty(leader,member) return check true/false
    // called when a leader invites someone
    CanAddToParty (string exported_func_name)
    // OnAddToParty(who) return check none
    // called when a member is added to a party
    OnAddToParty(string exported_func_name)
    // CanRemoveMember(leader,member) return check true/false
    // called when leader wants to remove member
    CanRemoveMember (string exported_func_name)
    // CanLeaveParty (member) return check true/false
    // called when member wants to leave the party
    CanLeaveParty (string exported_func_name)
    // OnLeaveParty(who,fromwho) return check none
    // called when member leaves the party
    OnLeaveParty(string exported_func_name)
    // OnPublicChat(member,uctext) return check none
    // called when a member sends a PartyMsg e.g. for logging
    OnPublicChat (string exported_func_name)
    // OnPrivateChat(member,tomember,uctext) return check none
    // called when a member sends a PrivateMsg e.g. for logging
    OnPrivateChat (string exported_func_name)
    // OnDisband(partyref) return check none
    // called when a Party is about to be disbanded
    OnDisband (string exported_func_name)
    // ChangePublicChat(member,uctext) return new uctext/true/false
    // called when a member sends a PartyMsg return value is the new uctextarray,
    // or true for no change, or false to block the msg
    ChangePublicChat (string exported_func_name)
    // ChangePrivateChat(member,tomember,uctext) return new uctext/true/false
    // called when a member sends a PrivateMsg return value is the new uctextarray,
    // or true for no change, or false to block the msg
    ChangePrivateChat (string exported_func_name)
    // OnPartyCreate(party) return check none
    // called when a party is created
    OnPartyCreate (string exported_func_name)
    // OnDecline(who) return check none
    // called when a Char declines a partyinvite
    OnDecline (string exported_func_name)
    // OnLootPermChange(who) return check none
    // called when a Char changes the LootPermission
    OnLootPermChange (string exported_func_name)
}

Enabled       (0/1)
Name          (string package name)
Requires      (string package name) [(int version)] ...
Replaces      (string package name) ...
Conflicts     (string package name) ...
[Version      (string version number {default 0})]
[CoreRequired (int core version without leading 0, or full version string)]
[ProvidesSystemHomePage (0/1)]

[Maintainer   (string name)]
[Email        (string email)]

PackageRoot
{
    dir (string fully qualified path)
    [dir...]
}

UoDataFileRoot=(path to UO MUL files {see Windows-specific notes})
WorldDataPath=(path to POL Data files {default data/})
RealmDataPath=(path to POL Realm files {default realm/})
PidFilePath=(where POL will write its .pid file {default ./})
[CountResourceTiles=(1/0 {default 1}]
[WebServer=(1/0 {default 0})]
[WebServerPort=(int port {default 8080})]
[IgnoreLoadErrors=(1/0 {default 0})]
[AccountDataSave=(1/0 {default -1})]
[Verbose=(1/0 {default 0})]
[LogLevel=(int level {default 0})]
[SelectTimeout=(int {default 10})]
[WatchRpm=(1/0 {default 0})]
[WatchSysLoad=(1/0 {default 0})]
[WatchMapCache=(1/0 {default 0})]
[LogSysLoad=(1/0 {default 0})]
[InhibitSaves=(1/0 {default 0})]
[LogScriptCycles=(1/0 {default 0})]
[ProfileCProps=(1/0 {default 0})]
[WebServerLocalOnly=(1/0 {default 1})]
[WebServerDebug=(1/0 {default 0})]
[WebServerPassword=(string {default empty})]
[CacheInteractiveScripts=(1/0 {default 1})]
[ShowSpeechColors=(1/0 {default 0})]
[RequireSpellbooks=(1/0 {default 1})]
[EnableSecureTrading=(1/0 {default 0})]
[RunawayScriptThreshold=(long {default 5000})]
[InactivityWarningTimeout=(int minutes {default 4})]
[InactivityDisconnectTimeout=(int minutes {default 5})]
[MinCmdlevelToLogin=(int level {default 0})]
[MinCmdLvlToIgnoreInactivity=(int level {default 1})]
[MaxCallDepth=(int depth {default 100})]
[ThreadStacktracesWhenStuck=(1/0 {default 0})]
[DumpStackOnAssertionFailure=(1/0 {default 0})]
[DisplayUnknownPackets=(1/0 {default 0})]
[ExpLosChecksMap=(1/0 {default 1})]
[EnableDebugLog=(1/0 {default 0})]
[DebugPort=(int port {default 0})]
[DAPDebugPort=(int port {default 0})]
[DebugPassword=(string {default empty})]
[DebugLocalOnly=(1/0 {default 1})]
[DebugLevel=(int level {default 0})]
[ReportRunToCompletionScripts=(1/0 {default 1})]
[ReportCriticalScripts=(1/0 {default 1})]
[ReportMissingConfigs=(1/0 {default 1})]
[MaximumClients=(int {default 300})]
[MaximumClientsBypassCmdLevel=(int cmdlevel {default 1})]
[AllowMultiClientsPerAccount=(1/0 {default 0})]
[CharacterSlots=(int {default 5})]
[MiniDumpType=(string small/large/variable {default variable})]
[RetainCleartextPasswords=(1/0 {default 0})]
[AssertionFailureAction=(abort/continue/shutdown/shutdown-nosave/shutdown-save-full/shutdown-save-incremental {default abort})]
[ShutdownSaveType=(full/incremental {default full})]
[TimestampEveryLine=(1/0 {default 0})]
[MaxTileID=(0/0x3FFF/0x7FFF/0xFFFF {default is 0})]
[MaxObjtype=(0x20000/0xFFFFFFFF {default 0x20000})]
[MaxAnimID=(0x800/0xFFFFFFFF {default 0x800})]
[DiscardOldEvents=(1/0 {default 0})]
[UseSingleThreadLogin=(1/0 {default 0})]
[DisableNagle=(1/0 {default 0})]
[ShowRealmInfo=(1/0 {default 0})]
[EnforceMountObjtype=(1/0 {default 0})]
[SingleThreadDecay=(1/0 {default 0})]
[ThreadDecayStatistics=(1/0 {default 0})]
[ReportCrashsAutomatically=(1/0 {default 0})]
[ReportAdminEmail=(string email {default ""})]
[ReportServer=(string servername {default "polserver.com"})]
[ReportURL=(string url {default "/pol/report_program_abort.php"})]
[ShowWarningGump=(1/0 {default 1})]
[ShowWarningItem=(1/0 {default 1})]
[ShowWarningCursorSequence=(1/0 {default 1})]
[AllowedEnvironmentVariablesAccess=(string {default ""})]
[EnableColoredOutput=(1/0 {default 1})]

Region (region name)
{
    Range             (x-west) (y-north) (x-east) (y-south)
    [Realm            (string realmname {default "britannia"})]
    [Guarded          (0/1 {default 0})]
    [EnterText        (string message)]
    [LeaveText        (string message)]
    [EnterScript      (string script)]
    [LeaveScript      (string script)]
    [Midi             (int music number)]
    [NoCast           (0/1 {default 0})]
    [NoCombat         (0/1 {default 0})]
    [LightLevel       (int light level {default 0}]
    [WeatherType      (int type {default 0})]
    [WeatherSeverity  (int severity {default 0})]
    [WeatherAux       (int {default 0})]
    [LightOverride    (int light level override {default -1})]
}
[Region...]

NameColoring
{
    Murderer        (int color 38 is red)
    Criminal        (int color 905 is grey)
    Attackable      (int color 905 is grey)
    Innocent        (int color 90 is blue)
    Invulnerable    (int color)
    GuildAlly       (int color 68 is green)
    GuildEnemy      (int color 44 is something)
}

General
{
    CriminalFlagInterval (int seconds)
    AggressorFlagTimeout (int seconds)
    PartyHelpFullCountsAsCriminal (1/0 default 0)
    PartyHarmFullCountsAsCriminal (1/0 default 1)
}

HookList
{
    NameColor      (string exported_func_name)
    HighLightColor (string exported_func_name)
    OnAttack       (string exported_func_name)
    OnDamage       (string exported_func_name)
    OnHelp         (string exported_func_name)
}

ResourceSystem
{
    ResourceType        (string resource type)
    [ResourceType...]
}

Global
{
    InitialUnits     (long number of resource units world has to start)
    [LandTile        (int landtile ID)]...
    [ObjType         (int arttile ID)]...
}
Region  (string regionname)
{
    Range               (x-west) (y-north) (x-east) (y-south)
    UnitsPerArea        (int resource units per tile)
    SecondsPerRegrow    (int seconds delay between regrows)
    Capacity            (int unit capacity for this region)
}
[Region...]

GameServer
{
    Name        (string name of server)
    IP          (string ip address, or --ip-- or --lan--, see below)
    Port        (int TCP port number)
    [IPMatch    (IPaddrr)/(netmask)]...
    [ProxyMatch (IPaddrr)/(netmask)]...
    [AcctMatch  (string account name)]...
}
[GameServer...]

[AllowSecureTradingInWarMode    (0/1)]
[DefaultDecayTime               (int minutes)]
[DefaultDoubleclickRange        (int range {default 2})]
[DefaultAccessibleRange         (int range {default DefaultDoubleclickRange})]
[DefaultLightLevel              (int level)]
[MovementUsesStamina            (0/1)]
[TotalStatsAtCreation           (string see below)]
[DefaultContainerMaxItems       (int 0-150)]
[DefaultContainerMaxWeight      (int 0-65535)]
[UOFeatureEnable                (int flags {default 0})]
[MaxPathFindRange               (int distance {default 50})]
[HiddenTurnsCount               (0/1 {default 1})]
[ItemColorMask                  (int mask {default 0xfff})]
[DecayItems                     (0/1 {default 1})]
[RefreshDecayAfterBoatMoves     (0/1 {default 1})]
[UseTileFlagPrefix              (0/1 {default 1})]
[UseWinLFH                      (0/1 {default 0})]
[EventVisibilityCoreChecks      (0/1 {default 0})]
[DoubleClickWait                (int seconds {default 0})]
[InvulTag                       (0/1/2 {default 1})]
[StartingGold                   (int {default 100})]
[PrivacyPaperdoll               (0/1 {default 0})]
[ForceNewObjCachePackets        (0/1 {default 0})]
[AllowMovingTrade               (0/1 {default 0})]
[CoreHandledLocks               (0/1 {default 0})]
[DefaultAttributeCap            (int in tenths {default 1000})]
[CoreSendsCaps                  (0/1 {default 0})]
[CoreIgnoresDefenceCaps         (0/1 {default 0})]
[SendStatLocks                  (0/1 {default 0})]
[MaxContainerSlots              (int {default 125})]
[UseContainerSlots              (0/1 {default 0})]
[EditServer                     (0/1 {default 0})]
[CarryingCapacityMod            (double {default 1.0})]
[SpeechRange                    (int range {default 12})]
[WhisperRange                   (int range {default 2})]
[YellRange                      (int range {default 25})]
[CoreSendsSeason                (0/1 {default 1})]
[CoreHandledTags                (int bitfield {default 0xffff})]
[SupportFaces                   (0/1/2 {default 0})]
[NewbieStartingEquipment        (0/1 {default 1})]
[SpeedhackPrevention            (0/1 {default 0})]
[ScriptedMerchantHandlers       (0/1 {default 0})]
[HonorUnequipScriptOnDeath      (0/1 {default 0})]
[SpeedHack_MountRunDelay        (int milliseconds {default 80})]
[SpeedHack_MountWalkDelay       (int milliseconds {default 180})]
[SpeedHack_FootRunDelay         (int milliseconds {default 180})]
[SpeedHack_FootWalkDelay        (int milliseconds {default 380})]
[SeperateSpeechTokens           (0/1 {default 0})]
[CoreGuildMessages              (0/1 {default 1})]
[MobilesBlockNpcMovement        (0/1 {default 1})]
[DefaultCharacterHeight         (1-32 {default 15})]
[EnableWorldMapPackets          (0/1 (default 0))]
[UndoGetItemEnableRangeCheck    (0/1 {default 0})]
[UndoGetItemDropHere            (0/1 {default 0})]
[BoatSailsCollide               (0/1 {default 0})]

Spell (int spellid)
{
    SpellID     (int spellid)
    Name        (string name)
    PowerWords  (string power words)
    Script      (string script name)
    Animation   (int casting animation ID)
    [Circle     (int Circle number)]
    [Reagent    (string item name)]...

    [Mana       (int manacost)]
    [Difficulty (int difficulty)]
    [PointValue (int skillbonus)]
    [Delay      (int cast delay)]
}
[Spell...]

Stacking
{
    IgnoreCprops  [(propname1) [(propname2)]...]  //space delimited
}

StartingLocation
{
    City        (string CityName)
    Description (string Description)
    MapID       (int mapid {default 0})
    Cliloc      (int clilocid {default 1075072})
    Coordinate  (int x),(int y),(int z)
    Realm       (string realm)
}
[StartingLocation...]

SystemHookScript (string script_name_with_ecl)
{
    (SyshookName) (string exported_func_name)
}
[SystemHookScript...]
SystemMethod
{
    (MethodHookName) (string scriptname)
    ...
}

General
{
    Strength        (string Strength)
    Intelligence    (string Intelligence)
    Dexterity       (string Dexterity)

    Hits            (string Life)
    Mana            (string Mana)
    Stamina         (string Stamina)
    MaxSkillID      (integer maximum UO client skill ID)
    [MethodScript   (string scriptname)]
}
Protocol
{
    #
    # EnableFlowControlPackets: use the 0x33 (0x00 / 0x01) pause/restart packets.
    # Though OSI seems to no longer send these packets, they seem to help with smoothness,
    # particularly with boat movement.
    # NOTE: causes clients 4.0.0e and newer to fail login
    EnableFlowControlPackets    (integer 0/1)
}
Listener
{
    Port             (int port number 1024..65535)
    KeepClients      (integer 0/1 {default 0})
    Encryption       (string encryption type {default none})
    AOSResistances   (integer 0/1)
    [AllowProxy      (IPaddrr)[/(netmask)]]...
}
[Listener ...]

#
# UseNoShoot:         means uoconvert will determine whether or not something blocks LOS by use of
#                     the NoShoot tiledata flag instead of the Blocking tiledata flag.
# LOSThroughWindows:  only matters if UseNoShoot is 1. If LOSThroughWindows is 1, then
#                     items marked as windows in tiledata will not impede LOS.
#
# Both of these options default to false. When UseNoShoot is false, the old method of
# determining sight blocking as being equivalent to ability to pass will be used for LOS.
#
LOSOptions
{
    UseNoShoot        (integer 0/1)
    LOSThroughWindows (integer 0/1)
}

#
# MaxStaticsPerBlock:         max. Amount of Static Items per Block of 8x8x256
#                             it is hard limited to 10000. default is 1000.
#
# WarningStaticsPerBlock:     max. Amount of Static Items per Block of 8x8x256 - just a Warning Level
#                             it is hard limited to 10000. default is 1000.
#
# ShowIllegalGraphicWarning:  show warning if Static with illegal Graphic# found
#                             0 or 1. default is 1.
#
StaticOptions
{
    MaxStaticsPerBlock        (int statics number 0..10000)
    WarningStaticsPerBlock    (int statics number 0..10000)
    ShowIllegalGraphicWarning (integer 0/1)
}

#
# ShowRoofAndPlatformWarning: show warning if Roof and Platform Flag are used at same Tile
#                             0 or 1. default is 1.
#
TileOptions
{
    ShowRoofAndPlatformWarning (integer 0/1)
}

MultiTypes
{
  Boats (int MultiID) [(int MultiID) ...]

  Houses (int MultiID) [(int MultiID) ...]

  Stairs (int MultiID) [(int MultiID) ...]
}

Mounts
{
  Tiles (int ItemID) [(int ItemID) ...]
}

Packet (packet ID byte)
{
  Length            (fixed integer length or 'variable' without quotes)
  [Version          (1,2 {default 1})]
  [ClientVersion    (ClientVersion string {default 1.25.25.0})]
  [ReceiveFunction  (string scriptname:functionname)]
  [SendFunction     (string scriptname:functionname)]
  [SubCommandOffset (int)]
  [SubCommandLength (1, 2 or 4)]
}
[Packet...]

SubPacket (main packet ID byte)
{
  SubCommandID     (int sub-command id)
  [Version          (1,2 {default 1})]
  [ClientVersion    (ClientVersion string {default 1.25.25.0})]
  [ReceiveFunction (string scriptname:functionname)]
  [SendFunction    (string scriptname:functionname)]
}
[SubPacket...]

Skill (SkillID)
{
    Attribute   (Attribute_name)
}
Additional entries required up to maximum UO skill id

Vital (Vital_Name)
{
    RegenRateFunction   (string scriptname:exported_func_name)
    MaximumFunction     (string scriptname:exported_func_name)
    [Alias              (string Alias_Name)]...
    [DepletedFunction   (string scriptname:exported_func_name)]
    [RegenWhileDead     (integer 0/1 {default 0})]
}
[Vital...]

[Combat (0 or 1)]
[ProfileScripts (0 or 1)]

Region (region name)
{
    Range             (x-west) (y-north) (x-east) (y-south)
    [Realm            (string realmname {default "britannia"})]
    [WeatherType      (int type {default 255})]
    [WeatherSeverity  (int severity {default 0})]
    [WeatherAux       (int {default 0})]
    [LightOverride    (int light level override {default -1})]
}
[Region...]

MIME (string extension)
{
    Extension (string extension)
    MIME      (string mime)
}
[MIME...]