POL Configuration Files

This is a list of all the files that are read by or used by the Core. Any other files are used by user scripts and are not listed here.

In the following config file explanations, some punctuation is used to show repetition, arbitrary values, and optional entries:

- No punctuation: text must be the same verbatim.
- enclosed in brackets [ ]: text is an optional entry.
- enclosed in parenthesis ( ): text is an arbitrary value.
- enclosed in curly braces { }: text is the default value.
- elipsis ... : repeat entries are allowed.

This means the punctuation in these cases should NOT be in the actual config files used by POL, they only appear here for information purposes. Exception: curly braces { } are used to define an element in a config file. These must be present in the actual file.

Last Modified: 6/18/2003

animxlate.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the mappings for animation codes for standing and while on horseback.
Structure
    OnMount
    {
        [(int normal animation) (int mounted animation)]...
    }

armrdesc.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes, d'oh!
Required/Used by
Core
Purpose
Obselete! Use itemdesc.cfg
Structure
    [same as an 'Armor' entry in itemdesc.cfg]
Explanation
Please don't use this.
Related Files
itemdesc.cfg

armrzone.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines armor zones for character layers, and chance to hit each zone.
Structure
    ArmorZone
    {
        Name    (string zone name)
        Chance  (int chance to hit)
        [Layer  (int UO client layer)]...
    }
    [ArmorZone...]
Explanation
Chance is a percent chance to hit this zone. I.e. 'Body' might be a 44 percent chance to hit, and 'Head' a 14 percent chance.
Layer is for the different equipped item layers the UO client uses. For example, items that are only equipped on the arms (like platemail arms) are layer 19. You may define multiple layers per zone.

attributes.cfg
Location: | Any Package
Number Allowed | any
Required to Start? | Yes
Required/Used by
Core
Purpose
Defines Attribute names and aliases
Structure
    Attribute (Attribute_Name)
    {
        [Alias                      (Alias_Name)]...
        [GetIntrinsicModFunction    (script_name:exported_func_name)]
    }
    [Attribute...]
Explanation
Attribute_Name defines the UNIQUE name for this attribute, like 'Cooking', 'Tactics', 'Strength', etc.
Aliases are optional and any number maybe be assigned for each attribute. This way 'STR' may be used in place of 'Strength'
At the LEAST, these attributes must be defined: 'Strength', 'Intelligence', 'Dexterity', 'Parry', and 'Tactics' for use in internal calculations.
GetIntrinsicModFunction returns a value between -30000 and +30000 that is added to the Attribute "base" value to obtain the "effective" value for the attribute. The function is called when UO.EM RecalVitals is called.
Related Files
uoclient.cfg
vitals.cfg

auxsvc.cfg
Location: | Any Package
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines an Auxilliary Interface Service script in the current package.
Structure
    AuxService
    {
        Port (intger port)
        Script (string script filename)
    }
Explanation
Port is a different port than the gameserver uses. This will be the port your AUX interface external program uses to connect to the server.
Script is the script filename the core will call when it receives an AUX connection (the 'program' in the file will be called)

bannedips.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines IP address ranges that are not allowed to connect to the game server.
Structure
    BannedIP
    {
        IPMatch (IPaddress)[/(netmask)]
    }
    [BannedIP...]
Explanation
If netmask is not defined, the default is 255.255.255.255 (exact IP match).

boats.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Defines the locations of all item components for each boat 'facing' graphic.
Structure
    Boat
    {
        ObjType                     (int boat multi graphic)
        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)
    }
    [Boat...]
Explanation
ObjType should be >= 0x4000.
All the x,y tile distance offsets are from the ship's mast. As normal on the map, positive X is east, positive Y is south. It doesn't matter what 'facing' of the boat this is for, parts of the boat that are east of the mast are defined with positive X values, parts south of the mast are defined with positive Y values, and vice versa.

circles.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Configures the 'spell circles', groups of increasing power spells.
Structure
    Circle (int number)
    {
        Mana        (int manacost)
        Difficulty  (int spell difficulty)
        PointValue  (int skill gain value)
        Delay       (int second casting delay)
    }
    [Circle...]
Explanation
This file used to determine mana, skill gain, etc. for each group of spells, but it's probably obselete now.

cmds.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Configures the command level heirarchy for the server.
Structure
    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}
Explanation
Command levels are defined in increasing order of power. Command level 'numbers' will be assigned automatically from this file.
If you change the cmdlevel names from player/coun/seer/gm/admin/test, it is recommended you define 'Alias' lines to associate these basic cmdlevels with your custom cmdlevels. This way, package cmds.cfg files will place their commands into your command structure.
Additional DIR properties allow you to specify additional commands in packages, just set your path to i.e. /pkg/mypkg/textcmd/admin .

combat.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Defines some combat-specific options.
Structure
    [DisplayParrySuccessMessages (0/1)]
    [WarmodeInhibitsRegen        (0/1)]

console.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Configures command characters that activate scripts when typed on the POL console.
Structure
    Commands
    {
        [CMD  (letter)  (script) [(description}]]
        [CMD...]
    }
Explanation
'letter' is case sensative, so 'a' can run a different script than 'A'. And '^A' is activated with CTRL-A
'script' must be placed in /scripts/console.
'?' is the help command - it prints the descriptions of all the other console commands.
The number keys (0-9) are reserved for the shutdown scripts (after a certain delay)
'^C' (CTRL-C) is reserved for immediate core shutdown.
There are three special command script names: [lock] locks the console, no further console commands may be entered. [unlock] unlocks the console from the locked state, and [lock/unlock] toggles the lock status of the console.
Reloadable with ReloadConfiguration() (polsys.em) or SIGHUP under linux

ecompile.cfg
Location: | same directory as ecompile.exe only
Number Allowed | 1
Required to Start? | No
Required/Used by
ecompile
Purpose
Configures module, include, and package paths for compiling.
Structure
    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
    [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.
Explanation
The 'generate' properties allow default behavior for generating listing or debug files.
If not found, ecompile will try to locate module and include directories from the system environment variables ECOMPILE_PATH_EM and ECOMPILE_PATH_INC.
use ECOMPILE_CFG_PATH environment variable to find ecompile.cfg. (note that normally it tries to look where the executable is. Some shells don't always pass this, particularly if you're using batch files or shell scripts - try putting the full path to ecompile in your batch file)
Using this file allows 'packaged includes' because now ecompile knows about the path to packages, allowing it to find include files using the normal package descriptor format ':pkgname:includename:'

equip.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core, on behalf of UO::EquipFromTemplate
Purpose
Defines default outfit templates, usually for NPCs, using EquipFromTemplate(character,templatename).
Structure
    Equipment (templatename)
    {
        [Armor  (item name or objtype) [(color)]]
        [Weapon (item name or objtype) [(color)]]
        [Equip  (item name or objtype) [(color)]]
    }
    [Equipment...]
Explanation
Note 'Armor', 'Weapon', and 'Equip' are all equvilent, they no longer hold any seperate meaning.
Careful with comment lines in this file, they might cause problems.

fileaccess.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | No
Required/Used by
per-package file.em access
Purpose
Specifies what packages have file read/write/append access.
Structure
    FileAccess
    {
    	[Package (string package name, or *)]...
    	[Directory (string directory name, 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})]
    }
Explanation
'*' above means it applies to all packages.
AllowRemote means the package has access to other files, not just files in its package directory.
Package matches the string name in a pkg.cfg. You can define multiple Package properties.
Directory not implimented yet
Extension examples are '.cfg', '.htm', etc. You can define multiple Extension properties.
This config is reloadable on-demand. Use ReloadConfiguration() (polsys.em) or SIGHUP under linux.

itemdesc.cfg
Location: | /config and/or any package
Number Allowed | any
Required to Start? | Yes
Required/Used by
Core
CreateItem functions
Purpose
Defines Item descriptions, to be assigned to individual items on creation. Note each UObject class expects different properties to be present, so each will be listed below. An actual itemdesc.cfg file would not look exactly like this. Class Name must be one of: CONTAINER ITEM DOOR WEAPON ARMOR BOAT HOUSE MAP .
Structure
    (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)]
        [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})]
        [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})]
        [Invisible      (0/1 {default 0})]
        [DecaysOnMultis (0/1 {default 0})]
        [BlocksCastingIfInHand   (0/1 {default 0})]
        [StrRequired    (int strength {default 0})]
        [Weight         (int weight {default tiledata value})]
        [OldObjtype     (int old objtype)]...
        [StackingIgnoresCProps   (propname1) [(propname2)]... ]
        [Resource       (string resource name) (int amount)]
        [Resource...]
    }
    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})]
        [CanInsertScript    (string scriptname)]
        [OnInsertScript     (string scriptname)]
        [CanRemoveScript    (string scriptname)]
        [OnRemoveScript     (string scriptname)]
    }
    Door (objtype)
    {
        {everything Item can have, plus: }
        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 house)
    }
    Map (objtype)
    {
        {everything Item can have, plus: }
        Editable        (0/1 {default 1})]
    }
    Weapon (objtype)
    {
        {everything Item can have, plus: }
        Speed            (int weapon attack speed)
        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)]

        [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})]
        [Intrinsic       (0/1 {default 0})]
    }
    Armor (objtype)
    {
        {everything Item can have, plus: }
        AR               (int armor rating)
        [OnHitScript     (string script name)]
        [Coverage        (string armor zone name {defaults to layer number zone})]
        [Coverage...]
    }
    ...and lots of any of these in the file...
Explanation
Note: if objtype < 0x4000, the 'graphic' property is not required, it is assumed objtype=graphic in this case.
Valid ranges for custom items are 0x5000-0xEFFF (0xF000-0xFFFF reserved by core)
Properties having to do with equipping an item is only meaningful if the item is actualy equippable (determined by the graphic number's tiledata flags).
Item Create, Destroy, and Control scripts are in pkg format or in scripts/control. Method scripts must be packaged.
Container scripts are in pkg format, or in scripts/control
RequiresAttention 1 causes container gumps to close when you move, or to unhide you if the item is used.
StackingIgnoresCProps is a space-delimited list of case-sensative CProp names that are ignored when stacking 2 of this item objtype. See also stacking.cfg for a global list.
Related Files
stacking.cfg

justice.cfg
Location: | /regions only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the justice regions (protected by guards). See also regions.cfg.
Structure
    Region (region name)
    {
        Range        (x-west) (y-north) (x-east) (y-south)
        [Guarded     (0/1 {default 0})]
        [EnterText   (string message)]
        [LeaveText   (string message)]
    }
    [Region...]
Explanation
Important: regions only override regions found earlier in the file. So the first region should cover the entire map, and further regions override portions of the world.
This file is preferred over regions.cfg for the above properties.
IMPORTANT: Regions are limited to POL's internal 64x64 tile zones and will internally expand to fill all of these zones the Range is contained in. This sucks, we know.
Related Files
regions.cfg

light.cfg
Location: | /regions only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the light regions (light levels sent to clients). See also regions.cfg.
Structure
    Region (region name)
    {
        Range        (x-west) (y-north) (x-east) (y-south)
        [Light       (int light level {default 0}]
    }
    [Region...]
Explanation
Important: regions only override regions found earlier in the file. So the first region should cover the entire map, and further regions override portions of the world.
This file is preferred over regions.cfg for the above properties.
IMPORTANT: Regions are limited to POL's internal 64x64 tile zones and will internally expand to fill all of these zones the Range is contained in. This sucks, we know.
Related Files
regions.cfg

menus.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
SelectMenuItem2()
Purpose
Configures old-style static menus for client selection (i.e. tailoring, fletching, etc.)
Structure
    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...]
Explanation
The 'Name' property must exactly match with the 'SubMenu' menuname for the submenu element.
Static menus in this file are used with UO::SelectMenuItem2()

movecost.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the stamina cost to move based on percent maximum weight carried.
Structure
    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}
    }
Explanation
You can specify a number of percentage capacity lines, and values in between will be linearly interpolated. 'Over' defines cost if maximum carrying capacity was exceeded.
Maximum carrying capacity is determined as ((Strength * 7) / 2) + 40. The multiplier used will be the current weight/max capacity. This multiplier is multiplied by 8 to find the amount of stamina 'hundreths' to consume per move. So a multiplier of 10 will consume 0.8 of a stamina 'point' per move.
The 'MovementCost' section overrides both the 'Walking' and 'Running' sections if present.
Used only of MovementUsesStamina=1 in servspecopt[.local].cfg
Related Files
servspecopt.cfg

multis.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Maps the UO 'MultiID' number with the graphic number for the multi.
Structure
    House (int multid)
    {
        Graphic (int graphic)
    }
    [House...]

    Boat (int multid)
    {
        (int graphic)
    }
    [Boat...]
Explanation
Use InsideUO to get the MultiIDs. Multi Graphics start at 0x4000 and are equal to 0x4000 + MultiID.

music.cfg
Location: | /regions only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the music regions. See also regions.cfg.
Structure
    Region (region name)
    {
        Range        (x-west) (y-north) (x-east) (y-south)
        [Midi        (int music number)]
    }
    [Region...]
Explanation
Important: regions only override regions found earlier in the file. So the first region should cover the entire map, and further regions override portions of the world.
This file is preferred over regions.cfg for the above properties.
IMPORTANT: Regions are limited to POL's internal 64x64 tile zones and will internally expand to fill all of these zones the Range is contained in. This sucks, we know.
Related Files
regions.cfg

nocast.cfg
Location: | /regions only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the "no spell casting allowed" regions. See also regions.cfg.
Structure
    Region (region name)
    {
        Range        (x-west) (y-north) (x-east) (y-south)
        [Nocast      (0/1 {default 0})]
    }
    [Region...]
Explanation
Important: regions only override regions found earlier in the file. So the first region should cover the entire map, and further regions override portions of the world.
This file is preferred over regions.cfg for the above properties.
IMPORTANT: Regions are limited to POL's internal 64x64 tile zones and will internally expand to fill all of these zones the Range is contained in. This sucks, we know.
Related Files
regions.cfg

npcdesc.cfg
Location: | /config and/or any package
Number Allowed | at least 1 in /config, can be packaged.
Required to Start? | Yes
Required/Used by
Core
CreateNpcFromTemplate
Purpose
Configures NPC Templates for creating new NPCs and assigning properties to them.
Structure
    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)
        Alignment              ('good' 'neutral' or 'evil)

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

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

        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})]
        [MaxHp                 (int maximum hitpoints for intrinsic weapon {default 1}]

        [MoveMode              (movemode string {default 'L'})]
        [Privs                 (string privilage) [(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})]
    }
    [NpcTemplate...]
Explanation
Movemode string is 'L' for land 'S' for sea, and 'A' for air. I.e. 'LS' would be good for a water elemental.
An 'intrinsic' weapon is used if the NPC does not have a weapon item equipped. It represents (usually), the Wrestling 'weapon' for the NPC. You can define sounds, damage etc.
Vital and Attribute names can use the aliases defined in attributes.cfg and vitals.cfg, i.e. 'STR' instead of 'Strength'. A Die-string may be used for the value of any of these.
Privs and settings can be like 'invul losany' and any more seperated by spaces. Unless they also appear in 'Settings', the privilages are not active.
UseAdjustments 1 means the NPC will adjust its facing while moving to try to avoid small obsticles. If 0, the NPC will not move if it cannot move forward, and the move function will return 0.
RunSpeed is only useful from 0-250, the higher the number, the shorter delay between moves.
SpeechColor and Font are only used if NPC::Say() is used.
Alignment determines NPC's name color and their participation in the reputation system.
Of course, you may define other config properties and cprops in this file that are not used by the core. npcdesc.cfg may be accessed with the normal Config file access functions (ReadConfigFile, etc). Note CProps in this file will be assigned to each NPC created with that template. This takes extra memory than if you look up properties using the config file access functions.
If you have npcdes.cfg in a package, the NPC's template name becomes :packagename:templatename
Related Files
resource.cfg

pkg.cfg
Location: | Any package
Number Allowed | 1 per package
Required to Start? | No
Required/Used by
Core
Purpose
Package descriptor file. One is required for every package. It is read only on POL startup.
Structure
    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)]
    [CoreRequired (int core version without leading 0, or full version string)]
    [ProvidesSystemHomePage (0/1)]

    [Maintainer   (string name)]
    [Email        (string email)]
Explanation
Maintainer and Email aren't read by the core, but you should still include them in your own packages.
Requires and Replaces refer to other package names that relate to this packet. If a package is defined that is 'required' and is not found, or is not a new enough version, an error will be printed.
Version is normal version syntax, i.e 1.0, 2.3, 0.1.1.2, etc.
CoreVersion is the POL version that is required for the package to function. Values should be formed like 94 or 95, not 094 or 095.
Enabled 0 causes none of the scripts or configs in this package to be read
CoreRequired can take a full version string like "POL095-2003-02-01"
ProvidesSystemHomePage lets a SINGLE pkg to act as directory the root for the web server

pkgroots.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the local file system paths to the root directories for packages. /pol/pkg is automatically checked.
Structure
    PackageRoot
    {
        dir (string fully qualified path)
        [dir...]
    }
Explanation
If my path was D:\beer\morepol, then subdirectories of that path would be searched for packages along with /pol/pkg

pol.cfg
Location: | root directory only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Configures many critical options for the POL server.
Structure
    UoDataFileRoot=(path to UO MUL files)
    [ListenPort=(integer TCP port)]
    [ClientEncryptionVersion=(string {default 1.26.4})]
    [CheckIntegrity=(1/0 {default 1})]
    [CountResourceTiles=(1/0 {default 1}]
    [ClientVersion=(integer {default 37})] obselete
    [Multithread=(1/0 {default 0})]
    [WebServer=(1/0 {default 0})]
    [WebServerPort=(int port {default 8080})]
    [UseNewStaticsFile=(1/0 {default 0})]
    [IgnoreLoadErrors=(1/0 {default 0})]
    [DebugPort=(int port {default 0})]

    [Verbose=(1/0 {default 0})]
    [LogLevel=(int level {default 0})]
    [SelectTimeout=(int {default 10})]
    [WatchRpm=(1/0 {default 0})]
    [WatchSysLoad=(1/0 {default 0})]
    [LogSysLoad=(1/0 {default 0})]
    [InhibitSaves=(1/0 {default 0})]
    [LogScriptCycles=(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})]
    [MaxCallDepth=(int depth {default 100})]
    [EnableAssertions=(1/0 {default 1})]
    [DumpStackOnAssertionFailure=(1/0 {default 0})]
    [DisplayUnknownPackets=(1/0 {default 0})]
    [ExpLosChecksMap=(1/0 {default 1})]
    [EnableDebugLog=(1/0 {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})]
    [MaximumClients=(int {default 300})]
    [MaximumClientsBypassCmdLevel=(int cmdlevel {default 1})]
    [MiniDumpType=(string small/large {default small})]
    [RetainCleartextPasswords=(1/0 {default 1})]
    [AssertionFailureAction=(abort/continue/shutdown/shutdown-nosave {default abort})]
Explanation
Your own pol.cfg should give descriptions on most of these. I'll describe them here if people want me to.
Clarification: for ClientEncryptionVersion, the allowable values are '1.26.4', '2.0.0', 'ignition', 'uorice', and 'none'. Here, 'ignition', 'uorice', and 'none' all mean 'no encryption'.
ListenPort is now optional, use uoclient.cfg Listener sections to define listening ports.
AssertionFailureAction options: abort: (like old behavior) aborts immediately, without saving data. continue: allows execution to continue. shutdown: attempts graceful shutdown. shutdown-nosave: attempts graceful shutdown, without saving data. If the assertion occurred during execution of a script, either 'shutdown', 'shutdown-nosave', or 'continue' will abort that script, displaying the script name and PC.

regions.cfg
Location: | /regions only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the regions in the world and various settings on each. See Explanation about splitting up this file.
Structure
    Region (region name)
    {
        Range        (x-west) (y-north) (x-east) (y-south)
        [Guarded     (0/1 {default 0})]
        [EnterText   (string message)]
        [LeaveText   (string message)]
        [Midi        (int music number)]
        [Nocast      (0/1 {default 0})]
        [Light       (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...]
Explanation
Important: regions only override regions found earlier in the file. So the first region should cover the entire map, and further regions override portions of the world.
'Guarded', 'EnterText', and 'LeaveText' are for 'justice' regions, and may be split into /regions/justice.cfg. guard.cfg will be the prefered location for these properties
'Midi' are for 'music' regions, and may be split into /regions/music.cfg, the prefered location for these regions.
'Nocast' are for 'nocast' regions and may be split into /regions/nocast.cfg, the prefered location for these regions.
'Light' are for 'light' regions and may be split into /regions/light.cfg, the prefered location for these regions.
'WeatherType', 'WeatherSeverity', 'WeatherAux', and 'LightOverride' are for 'weather' regions and may be split into /regions/weather.cfg, the prefered location for these regions.
IMPORTANT: Regions are limited to POL's internal 64x64 tile zones and will internally expand to fill all of these zones the Range is contained in. This sucks, we know.

repsys.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Defines coloring and timeouts for the reputation system.
Structure
    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)
        GuildAlly       (int color 68 is green)
        GuildEnemy      (int color 44 is something)
    }

    General
    {
        CriminalFlagInterval (int seconds)
        AggressorFlagTimeout (int seconds)
    }
Explanation
NameColoring defines the single-click name colors for mobiles with various reputation states.

resource.cfg
Location: | /regions only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Defines the resource types in the world. Other .cfg files are then read for specific resource configurations.
Structure
    ResourceSystem
    {
        ResourceType        (string resource type)
        [ResourceType...]
    }
Explanation
Important: regions only override regions found earlier in the file. So the first region should cover the entire map, and further regions override portions of the world.
If the resource type is 'ore', then 'ore.cfg' in the same directory will be read for resource region configurations for the ore resource.
Most of the configuration is done in these other files, so please see resourcetype.cfg (note not an actual file, just denotes files like ore.cfg)
Related Files
resourcetype.cfg

resourcetype.cfg
Location: | /regions only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the configuration for the resource filename. Note: 'resourcetype.cfg' does not exist, this only denotes files like 'ore.cfg' or 'wood.cfg'. See resource.cfg for how to define these resource types.
Structure
    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...]
Explanation
Important: regions only override regions found earlier in the file. So the first region should cover the entire map, and further regions override portions of the world.
Landtiles are the 'map' tiles, and 'ObjType' is for static art tiles. These numbers are used to know what tiles grow this type of resource. I.e. a static tree type for wood.
Example: this file is for wood resources, and UnitsPerArea is 15. This means I can get a maximum of 15 wood from a tree until the resources 'regrow'. I could define another region that has very plentiful, or fast growing trees and adjust the UnitsPerArea and SecondsPerRegrow accordingly.
Related Files
resource.cfg

servers.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Defines the Game Servers the login server will forward clients to. Normally the game server and login server are the same machine on a POL shard, but you could run a minimal POL server to act as a login server for one or more game servers.
Structure
    GameServer
    {
        Name     (string name of server)
        IP       (string ip address, or --ip-- or --lan--, see below)
        Port     (int TCP port number)
        [IPMatch (IPaddrr)/(netmask)]...
    }
    [GameServer...]
Explanation
IP address must match the address in the clients' login.cfg files. This means if your game server is on a LAN not accessable from the internet (doing port forwarding from a router), you must define this game server IP as your router's internet IP address.
--ip-- attempts to find your non-LAN, non-localhost IP address. If you have a multihomed server, this may behave strangely.
--lan-- attempts to find you non-routable LAN IP address, if any (i.e. '192.168.*.*' or '10.*.*.*').
Example IPMatch value: 192.168.0.0/255.255.255.0 would prevent anyone with an IP address other than 192.168.0.* from seeing the gameserver.
Port is the listening port of the Game Server, not the login server (though they may be the same). See ListenPort in pol.cfg
Related Files
movecost.cfg
pol.cfg

servspecopt.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | no
Required/Used by
Core
Purpose
Defines certain "Server Specific Options" that shard admins can set. If the file 'servspecopt.local.cfg' exists, the entries will be used in that file instead (to keep changes from being destroyed if a new servspecopt.cfg is installed from, say, the official distribution)
Structure
    [AllowSecureTradingInWarMode	(0/1)]
    [DefaultDecayTime	            (int minutes)]
    [DefaultDoubleclickRange        (int range)]
    [MovementUsesStamina            (0/1)]
    [TotalStatsAtCreation           (string see below)]
    [DefaultContainerMaxItems       (int 0-150)]
    [DefaultContainerMaxWeight      (int 0-65535)]
    [UOFeatureEnable                (int flags {default 0})]
Explanation
TotalStatsAtCreation takes a comma-delimited lists of values and/or ranges (default = '65,80'). Example: TotalStatsAtCreation=65,80,90-95,100-110
If MovementUsesStamina, stamina costs are defined in movecost.cfg
DefaultContainerMaxItems default is 125, DefaultContainerMaxWeight default is 250. itemdesc.cfg "MaxItems" and "MaxWeight" override these defaults.
UOFeatureEnable will be sent as the last DWORD flag in the 0xA9 login message. See 095+ package for values and warnings.
Related Files
movecost.cfg

skills.cfg
Location: | /config and/or any package
Number Allowed | any
Required to Start? | yes
Required/Used by
Core
Purpose
Defines the details for each UO skill.
Structure
    Skill (int skillid)
    {
        SkillID     (int skillid)
        Name        (string name)
        Delay       (int delay)
        UnHides     (0/1)
        Script      (string script name)
        [StrAdv     (percent chance to advance) (die-string amount to advance)]
        [IntAdv     (percent chance to advance) (die-string amount to advance)]
        [DexAdv     (percent chance to advance) (die-string amount to advance)]
    }
    [Skill...]
Explanation
NOTE, the distro doesn't use this file, it uses pkg/foundations/hooks/skillsdef.cfg instead, with the same structure.
Script is only meaningful for skills that are directly useable like Hiding, but not for ones accessed from an item (like Blacksmithing)
Only one entry for each skillid is allowed. Skillid can not be higher than the maximum number of UO client skills.
Delay is number of seconds before the user can use another skill.
If UnHides is 1, using the skill unhides the character if hidden.
Related Files
uoskills.cfg

spells.cfg
Location: | /config and/or any package
Number Allowed | any
Required to Start? | yes (can be empty)
Required/Used by
Core
SpeakPowerWords()
ConsumeReagents()
StartSpellEffect()
GetSpellDifficulty()
Purpose
Defines the spells used by the UO Client
Structure
    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...]
Explanation
Script is in current package or searches through /scripts
Animation is less or equal to 0x22
If the Circle property is found, Mana,Difficulty,PointValue, and Delay is gathered from circles.cfg.
Reagent name corresponds to the "Name" property for the reagent's itemdesc.cfg entry.
Related Files
itemdesc.cfg
circles.cfg

stacking.cfg
Location: | Any Package and/or /config
Number Allowed | any
Required to Start? | No
Required/Used by
Core Item Stacking
Purpose
Specifies CProp names to ignore when stacking two items.
Structure
    Stacking
    {
        IgnoreCprops  [(propname1) [(propname2)]...]  //space delimited
    }
Explanation
propnames are space-delimited, and are case-sensative.
This config may be packaged, so it's a good idea to only specify the cprops in the package which "belong" to that package.

startloc.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | yes
Required/Used by
Core
Purpose
Defines the starting locations for new clients. They must be in this order to match the character creation screens in the UO client: Yew, Minoc, Britain, Moonglow, Trinsic, Magincia, Jhelom, Skara Brae, Vesper
Structure
    StartingLocation
    {
        City		(string CityName)
        Description	(string Description)
        Coordinate	(int x),(int y),(int z)
    }
    [StartingLocation...]
Explanation
CityName and Description are sent to the client! no larger than 30 characters please.
x,y,z is where the character will be placed after created. You could set all the locations to the same coordinate to force players to start in one town.

syshook.cfg
Location: | Any package
Number Allowed | any
Required to Start? | no
Required/Used by
Core
Purpose
Defines the hook scripts to be called by the core at certain times.
Structure
    SystemHookScript (string script_name_with_ecl)
    {
        (SyshookName) (string exported_func_name)
    }
    [SystemHookScript...]
Explanation
Defines the script file and function to call for the core to call. The script should be in the same package as the syshook.cfg.
The script_name_with_ecl should define a 'program' which will be run on server start.
The exported_func_name should be defined with the 'exported' keyword.
The list of SyshookNames: CheckSkill, OpenSpellbook, GetBookPage, CombatAdvancement, ParryAdvancement, Attack, Pushthrough

uoclient.cfg
Location: | Any Package
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Maps vital and attribute names onto UO Client idioms for character status.
Structure
    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)
    }
    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    1
    }
    Listener
    {
        Port (int port number 1024..65535)
        Encryption (string encryption type)
    }
    [Listener ...]
Explanation
The right-hand-side "Strength", "Intelligence", and "Dexterity" are Attribute names that MUST be defined in attributes.cfg.
The right-hand-side "Life", "Mana", and "Stamina" are Vital names that MUST be defined in vitals.cfg.
MaxSkillID allows you to use new client skills, but setting it too high can crash older clients. You must define skills.cfg entries for each skillID up to MaxSkillID (default 51).
The Protocol and Listener sections are optional.
Each Listener section allows you to listen for different client encryption types on different ports. This means you can listen for "1.26.4" clients on port 5003 and "ignition" clients on port 5555. Valid encryption types are found in the pol.cfg section. If you use Listeners set ListenPort in pol.cfg to 0.
Related Files
attributes.cfg
pol.cfg
skills.cfg
vitals.cfg

uoskills.cfg
Location: | Any Package
Number Allowed | any
Required to Start? | Yes
Required/Used by
Core
Purpose
Maps Attribute names onto the UO Skill ID numbers.
Structure
    Skill (SkillID)
    {
        Attribute   (Attribute_name)
    }
    Additional entries required up to maximum UO skill id
Explanation
Attribute_name defines the Attribute associated with this UO Skill. Only one attribute may be mapped to a skill id. Attribute_name must be found in attributes.cfg!
SkillID must be an integer between 0 and 500, though any entries past the maximum UO skill id will not be sent to the UO client.
Related Files
uoclient.cfg
attributes.cfg

vitals.cfg
Location: | Any Package
Number Allowed | any
Required to Start? | Yes
Required/Used by
Core
Purpose
Defines Attribute names and aliases
Structure
    Vital (Vital_Name)
    {
        RegenRateFunction   (string scriptname:exported_func_name)
        MaximumFunction     (string scriptname:exported_func_name)
        [Alias              (string Alias_Name)]...
        [UnderflowFunction  (string scriptname:exported_func_name)]
    }
    [Vital...]
Explanation
Vital_Name defines the UNIQUE name for this vital, like 'Mana', 'Stamina', etc.
Aliases are optional and any number maybe be assigned for each vital. This way 'Hits' may be used in place of 'Life'
At the LEAST, these attributes must be defined: 'Life', 'Stamina', 'Mana' for use in internal calculations.
RegenRateFunction should return value from -30000 to 30000. Regen rates are in 'hundredths of points per minute.' A current regen rate of 100 (1 point per 5 seconds) would therefore be 1200 (12 points per minute)
MaximumFunction should return the maximum value for this vital, an integer in 'hundreths' between 100 and 10000000 (1-100,000)
UnderflowFunction not implimented.
Related Files
uoclient.cfg
attributes.cfg

watch.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes
Required/Used by
Core
Purpose
Turns on certain spammy debugging messages.
Structure
    [Combat (0 or 1)]
    [ProfileScripts (0 or 1)]
Explanation
If 'Combat 1' is in this file, information regarding combat damage, hits and misses, etc will be printed.
If 'ProfileScripts 1' is in this file, profiling information will be printed when any script exits.

weather.cfg
Location: | /regions only
Number Allowed | 1
Required to Start? | No
Required/Used by
Core
Purpose
Defines the weather regions. See also regions.cfg.
Structure
    Region (region name)
    {
        Range        (x-west) (y-north) (x-east) (y-south)
        [WeatherType      (int type {default 255})]
        [WeatherSeverity  (int severity {default 0})]
        [WeatherAux       (int {default 0})]
        [LightOverride    (int light level override {default 1})]
    }
    [Region...]
Explanation
Important: regions only override regions found earlier in the file. So the first region should cover the entire map, and further regions override portions of the world.
This file is preferred over regions.cfg for the above properties.
IMPORTANT: Regions are limited to POL's internal 64x64 tile zones and will internally expand to fill all of these zones the Range is contained in. This sucks, we know.
type: 0 - light rain ("It starts to rain") 1 - rain/thunder ("A fierce storm approaches") 2 - snow ("It begins to snow") 3 - brewing storm - ("A storm is brewing") 255 - None (Turns sound effects off) severity:is set on a 0-70 scale, 70=torrential rain, 0=light drizzle. aux: nothing lightoverride: light level amount overrides current level. -1 means no override.
Related Files
regions.cfg

wepndesc.cfg
Location: | /config only
Number Allowed | 1
Required to Start? | Yes, d'oh!
Required/Used by
Core
Purpose
Obselete! Use itemdesc.cfg
Structure
    [same as an 'Weapon' entry in itemdesc.cfg]
Explanation
Please don't use this.
Related Files
itemdesc.cfg

If you know if any information is incorrect on these pages, mail your corrections to racalac@burdell.org

Copyright ©2003 David Carpman, all rights reserved. DO NOT REPRODUCE, MIRROR, ALTER, SPINDLE, MUTILATE, OR SIT ON.