©

Configuration Parameters
The Portable Host
Version 3.2.3.2

INDEX


Introduction

PHOST 3 has over 210 configuration parameters that affect its operation. This gives the host a great deal of flexibility in how the game is run and provides many tools for the game designer who wishes to set up a custom scenario. With flexibility, however, comes the price of complexity. For players to memorize and understand the settings of over 210 parameters is a difficult task. Fortunately, all configuration parameters come with reasonable default settings. If the host does not wish to learn about the myriad configuration parameters, he/she can simply leave these settings at their default and rest assured that the game will work "sensibly". To reiterate PHOST's policy on complexity: PHOST is only as complex as you want it to be. Match PHOST's complexity to your own ability and experience.

PHOST's configuration parameters are stored in a file named PCONFIG.SRC, which is expected to reside in the game directory. The format of this file is described in the next section.

If you are only familiar with the original HOST program, note that this differs from HOST's configuration in that there is no HCONFIG program and no HCONFIG.HST configuration file. The PCONFIG.SRC file is the only configuration-related object for PHOST.

If you are familiar with PHOST 2.x, note that PHOST now reads the PCONFIG.SRC file directly, hence there is no need to compile the source file into a PCONFIG.HST file. Both the PCONFIG.HST file and the PCONFIG program have been eliminated in PHOST 3.

The subsequent sections in this document list the configuration parameters in the same order as they appear in the provided example PCONFIG.SRC files. That is, they are grouped according to related functionality. There is also an alphabetical listing of configuration options provided for reference.

Back to the index


The PCONFIG.SRC File

The PCONFIG.SRC file is a plain text file consisting of comments, section delimiters, and assignment statements. It is the assignment statements that set values for the various configuration parameters. The various PCONFIG.SRC files included in the PHOST distribution provide examples which you can modify.

The basic format of each assignment statement is:

Item = Setting [, Setting, Setting, ...]

where Item represents a configuration setting such as AllowMinefields or MineSweepRange. The Setting token represents the value to assign to this parameter. Numeric settings are simply integers, while boolean settings may take the values True, False, Yes, or No (there is no difference between True/Yes and False/No). Multiple settings are required for configuration items which are arrays (although most array-valued parameters allow shortcuts -- see below). In this case, each element is separated by commas or whitespace.

Note that all parameter names (on the left hand side of the =) are case-sensitive but parameter values (on the right hand side of the =) are not.

Comments

Comments in the PCONFIG.SRC file are marked by a line beginning with # (after any amount of whitespace). Comments may also be placed following all settings for a configuration item.

Multiple-Valued Assignments

Many configuration parameters are configurable on a per-player basis. This means that each player in the game can have a different setting for the parameter. A common example is the ColonistTaxRate configuration option. There are two ways of setting these parameters. The longhand way is to specify each value, like this:

ColonistTaxRate = 100,120,100,140,100,100,100,100,100,100,100

PHOST also allows a shorthand form of assignment when all players are to use the same parameter value:

ColonistTaxRate = 100

This shorthand assignment simply assigns the same value to all players.

Note that no in-between assignment format is possible. Either a single value may be specified, or all 11 values must be specified.

Sections

The PCONFIG.SRC file may be broken up into sections for use by different add-on programs and utilities. Each section is introduced with a line that begins with a % character and is followed by a section name. For example:

PHOST will only process configuration option assignments in a section marked with a section name of PHOST (as in the example above). If there is no section marker, then PHOST assumes that by default all options apply to it and will therefore process all assignments up to the end of the file or the first section delimiter.

The purpose behind section delimiters is to allow add-on programs and utilities to have their own sections for configuring program operation, yet allow the host to only maintain a single configuration file (PCONFIG.SRC). Thus, the configuration information that applies to the add-on program can be placed in a separate section and it will not interfere with PHOST's operation. Note that the fine-grain hosting control configuration is also stored in the PCONFIG.SRC file, under the section name of PCONTROL.

Defaults

Each configuration item has a default setting. If a configuration setting is not specified in the PCONFIG.SRC file, PHOST uses the default value. A warning message will be displayed for each default assignment when PHOST runs. Default assignments are not recommended because they do not explicitly indicate to players the configuration parameters that are in use for a game.

Player Modifications

The PHOST command processor allows players to modify some of the configuration options, such as Language, AllowMoreThan50Targets, and FilterPlayerMessages. When these options are modified by players, a new PCONFIG.SRC file is written out by PHOST and the old file saved as PCONFIG.BAK. The new file is written to the game directory.

Back to the index


Parameters Grouped by Function

This section describes PHOST's configuration parameters, grouped according to related function. The order in which these descriptions appear matches the order of assignments in the PCONFIG.SRC files that are provided with the PHOST 3 distributions. See the next section for an alphabetical listing of configuration parameters.

Each configuration name is followed by the allowable range of values that this parameter can take, as well as icons that describe various attributes. These icons have the following meanings:

This configuration parameter is only available in PHOST. Configuration parameters without this icon are also available in the original HOST program

This configuration parameter is an array indexed by player number. This means that each player can have a different value for this parameter.

This is an original HOST configuration parameter that has been "array-ized" to be per-player configurable. This means that each player can have a different value for this parameter.

General Options

GameName valid values: strings up to 31 characters

AllowRegisteredFunctions valid values: Yes No

ScoringMethod valid values: None Compatible

TonsScoreCountsPlanets valid values: Yes No

DisablePasswords valid values: Yes No

CPEnableBigTargets valid values: Yes No

AllowMoreThan50Targets valid values: Yes No

CPEnableLanguage valid values: Yes No

Language valid values: English German French Spanish Italian Dutch Russian Estonian

FilterPlayerMessages valid values: Yes No

CPEnableRaceName valid values: Yes No

RecycleRate valid values: 0 through 100

ScanRange valid values: 0 through 32767

SensorRange valid values: 0 through 32767

AllowNewNatives valid values: Yes No

AllowAlchemy valid values: Yes No

AllowScienceMissions valid values: Yes No

TerraformRate valid values: 1 through 100

CPEnableMessage valid values: Yes No

AllowPlayerMessages valid values: Yes No

DeleteOldMessages valid values: Yes No

CPEnableRumor valid values: Yes No

CPEnableAllies valid values: Yes No

DelayAllianceCommands valid values: Yes No

CPEnableGive valid values: Yes No

CPEnableRemote valid values: Yes No

AllowShipCloning valid values: Yes No

ShipCloneCostRate valid values: 0 through 32767

IonStormActivity valid values: 0 through 100

CPEnableSend valid values: Yes No

CPEnableJettison valid values: Yes No

AllowExtendedMissions valid values: Yes No

ExtMissionsStartAt valid values: 20 through 900

WormholeUFOsStartAt valid values: 1 through 801

AllowWraparoundMap valid values: Yes No

WraparoundRectangle valid values: 0 through 10000

AllowBeamUpClans valid values: Yes No

AllowBeamUpMultiple valid values: Yes No

Movement Options

AllowGravityWells valid values: Yes No

GravityWellRange valid values: 0 to 32767

RoundGravityWells valid values: Yes No

AllowHyperWarps valid values: Yes No

AllowHyperjumpGravWells valid values: Yes No

AllowNoFuelMovement valid values: Yes No

UseAccurateFuelModel valid values: Yes No

AllowOneEngineTowing valid values: Yes No

TowedShipsBreakFree valid values: Yes No

AllowAlternativeTowing valid values: Yes No

Racial Abilities

PlayerRace valid values: 1 through 12

MapTruehullByPlayerRace valid values: Yes No

AllowFedCombatBonus valid values: Yes No

AllowSuperRefit valid values: Yes No

AllowAntiCloakShips valid values: Yes No

AlternativeAntiCloak valid values: Yes No

AntiCloakImmunity valid values: Yes No

AllowHiss valid values: Yes No

HissEffectRate valid values: 0 through 100

MaxShipsHissing valid values: 1 through 500

AllowDeluxeSuperSpy valid values: Yes No

SpyDetectionChance valid values: 0 through 100

AllowGloryDevice valid values: Yes No

CumulativePillaging valid values: Yes No

RobFailureOdds valid values: 0 through 100

AllowGamblingShips valid values: Yes No

AllowBoardingParties valid values: Yes No

AllowPrivateerTowCapture valid values: Yes No

BorgAssimilationRate valid values: 0 through 100

AllowChunneling valid values: Yes No

AllowAlliedChunneling valid values: Yes No

AllowWebMines valid values: Yes No

CrystalsPreferDeserts valid values: Yes No

CrystalSinTempBehavior valid values: Yes No

AllowCrystalTowCapture valid values: Yes No

DarkSenseRange valid values: 0 through 32767

AllowImperialAssault valid values: Yes No

RobotsBuildFighters valid values: Yes No

RebelsBuildFighters valid values: Yes No

AllowRebelGroundAttack valid values: Yes No

AllowRGAOnUnowned valid values: Yes No

RGANeedsBeams valid values: Yes No

ColoniesBuildFighters valid values: Yes No

RamScoopFuelPerLY valid values: 0 through 100

AllowAdvancedRefinery valid values: Yes No

AllowBioscanners valid values: Yes No

Planetary Options

AllowPlanetAttacks valid values: Yes No

PlanetsAttackRebels valid values: Yes No

PlanetsAttackKlingons valid values: Yes No

DefenseForUndetectable valid values: 0 to 32767

FactoriesForDetectable valid values: 0 to 32767

MinesForDetectable valid values: 0 to 32767

AllowEatingSupplies valid values: Yes No

ClimateLimitsPopulation valid values: Yes No

ClimateDeathRate valid values: 0 to 100

NativeClimateDeathRate valid values: 0 to 100

MaxColTempSlope valid values: 0 through 32767

TransuraniumDecayRate valid values: 0 through 100

StructureDecayPerTurn valid values: 0 through 1000

RaceMiningRate valid values: 0 through 1638

ColonistTaxRate valid values: 0 through 10000

NativeTaxRate valid values: 0 through 10000

RaceGrowthRate valid values: 0 through 32767

ProductionRate valid values: 0 through 32767

MaxPlanetaryIncome valid values: 31-bit integer >= 0

FreeFighters valid values: 0 through 60

PlanetaryTorpsPerTube valid values: 0 through 100

Space Mines

AllowMinefields valid values: Yes No

MaximumMinefieldRadius valid values: 0 through 32767

UnitsPerTorpRate valid values: 0 to 32767

AllowMinesDestroyMines valid values: Yes No

AllowMinesDestroyWebs valid values: Yes No

MineScanRange valid values: 0 through 32767

MineHitOdds valid values: 0 through 100

MineOddsWarpBonusX100 valid values: 0 through 10000

MineTravelSafeWarp valid values: 0 through 9

MineHitDamageFor100KT valid values: 0 to 327

MineDecayRate valid values: 0 through 100

MineSweepRate valid values: 0 through 32767

MineSweepRange valid values: 0 through 32767

WebMineHitOdds valid values: 0 through 100

WebMineOddsWarpBonusX100 valid values: 0 through 10000

WebMineTravelSafeWarp valid values: 0 through 9

WebMineDecayRate valid values: 0 through 100

WebHitDamageFor100KT valid values: 0 to 327

WebDrainFuelLoss valid values: 0 through 32767

WebMineSweepRate valid values: 0 through 32767

WebMineSweepRange valid values: 0 through 32767

FighterSweepRange valid values: 0 through 32767

FighterSweepRate valid values: 0 through 32767

AllowColoniesSweepWebs valid values: Yes No

IonStormsHideMines valid values: Yes No

HullTechNotSlowedByMines valid values: 0 through 11

Meteors

RandomMeteorRate valid values: 0 through 100

MeteorShowerOdds valid values: 0 through 100

MeteorShowerOreRanges valid values: 0 through 32767

LargeMeteorsImpacting valid values: 0 through 500

LargeMeteorOreRanges valid values: 0 through 32767

AllowMeteorMessages valid values: Yes No

Cloaking

CloakFailureRate valid values: 0 through 100

AllowCloakFailMessages valid values: Yes No

RobCloakedShips valid values: Yes No

RobCloakedChance valid values: 0 through 100

CloakFuelBurn valid values: 0 through 1000

MineHitOddsWhenCloakedX10 valid values: 0 through 1000

CloakMineOddsWarpBonusX100 valid values: 0 through 10000

CloakedMineTravelSafeWarp valid values: 0 through 9

DamageLevelForCloakFail valid values: 0 through 100

AllowTowCloakedShips valid values: Yes No

AllowCloakedShipsAttack valid values: Yes No

Wormholes

AllowWormholes valid values: Yes No

WrmDisplacement valid values: 0 through 2000

WrmRandDisplacement valid values: 0 through 2000

WrmStabilityAddX10 valid values: -1000 through 1000

WrmRandStability valid values: 0 through 100

WrmMassAdd valid values: -10000 through 10000

WrmRandMass valid values: 0 through 10000

WrmVoluntaryTravel valid values: Yes No

WrmTravelDistDivisor valid values: 1 through 32767

WrmTravelWarpSpeed valid values: 0 through 9

WrmTravelCloaked valid values: Yes No

WrmEntryPowerX100 valid values: 0 through 100

Combat Options

GroundKillFactor valid values: 1 through 32767

GroundDefenseFactor valid values: 1 through 32767

AllowEngineShieldBonus valid values: Yes No

EngineShieldBonusRate valid values: 0 through 100

AllowESBonusAgainstPlanets valid values: Yes No

NativeCombatSurvivalRate valid values: 0 through 100

AllowInterceptAttack valid values: Yes No

Combat Parameters

BayRechargeRate valid values: 0 through 16384

BayRechargeBonus valid values: -500 through 500

BeamRechargeRate valid values: 0 through 16384

BeamRechargeBonus valid values: -4095 through 4095

TubeRechargeRate valid values: 0 through 16384

BeamHitFighterCharge valid values: 0 through 1000

BeamHitShipCharge valid values: 0 through 1000

TorpFiringRange valid values: 0 through 100000

BeamFiringRange valid values: 0 through 100000

TorpHitOdds valid values: 0 through 100

BeamHitOdds valid values: 0 through 100

BeamHitBonus valid values: -4095 through 4095

StrikesPerFighter valid values: 1 through 100

FighterKillOdds valid values: 0 through 50

FighterBeamExplosive valid values: 1 through 1000

FighterBeamKill valid values: 1 through 1000

ShipMovementSpeed valid values: 1 through 10000

FighterMovementSpeed valid values: 1 through 10000

BayLaunchInterval valid values: >= 1

MaxFightersLaunched valid values: 0 through 50

AllowAlternativeCombat valid values: Yes No

StandoffDistance valid values: 3000 through 60000

PlanetsHaveTubes valid values: Yes No

FireOnAttackFighters valid values: Yes No

TorpHitBonus valid values: -4095 through 4095

TubeRechargeBonus valid values: -4095 through 4095

ShieldDamageScaling valid values: 0 through 32767

HullDamageScaling valid values: 0 through 32767

CrewKillScaling valid values: 0 through 32767

ExtraFighterBays valid values: -20 through 20

BeamHitFighterRange valid values: 0 through 100000

FighterFiringRange valid values: 0 through 100000

Build Queue Parameters

Please see the "Ship Build Queue" page for descriptions of the following parameters.

SBQBuildPALBoost valid values: 0 through 100

SBQNewBuildPALBoost valid values: 0 through 100

SBQPointsForAging valid values: 0 through 10000

SBQBuildChangePenalty valid values: -1 through 2147483647

PALDecayPerTurn valid values: 0 through 100

PALPlayerRate valid values: 0 through 100

PALCombatAggressor valid values: 0 through 100

PALAggressorPointsPer10KT valid values: 0 through 100

PALOpponentPointsPer10KT valid values: 0 through 100

PALAggressorKillPointsPer10KT valid values: 0 through 100

PALOpponentKillPointsPer10KT valid values: 0 through 100

PALCombatPlanetScaling valid values: 0 through 200

PALCombatBaseScaling valid values: 0 through 200

PALShipCapturePer10Crew valid values: 0 through 100

PALRecyclingPer10KT valid values: 0 through 100

PALBoardingPartyPer10Crew valid values: 0 through 100

PALGroundAttackPer100Clans valid values: 0 through 100

PALGloryDevice valid values: 0 through 100

PALGloryDamagePer10KT valid values: 0 through 100

PALImperialAssault valid values: 0 through 100

PALRGA valid values: 0 through 100

PALPillage valid values: 0 through 100

Back to the index


Parameters Listed Alphabetically

A
AllowAdvancedRefinery
AllowAlchemy
AllowAlliedChunneling
AllowAlternativeCombat
AllowAlternativeTowing
AllowAntiCloakShips
AllowBeamUpClans
AllowBeamUpMultiple
AllowBioscanners
AllowBoardingParties
AllowChunneling
AllowCloakedShipsAttack
AllowCloakFailMessages
AllowColoniesSweepWebs
AllowCrystalTowCapture
AllowDeluxeSuperSpy
AllowEatingSupplies
AllowEngineShieldBonus
AllowESBonusAgainstPlanets
AllowExtendedMissions
AllowFedCombatBonus
AllowGamblingShips
AllowGloryDevice
AllowGravityWells
AllowHiss
AllowHyperjumpGravWells
AllowHyperWarps
AllowImperialAssault
AllowInterceptAttack
AllowMeteorMessages
AllowMinefields
AllowMinesDestroyMines
AllowMinesDestroyWebs
AllowMoreThan50Targets
AllowNewNatives
AllowNoFuelMovement
AllowOneEngineTowing
AllowPlanetAttacks
AllowPlayerMessages
AllowPrivateerTowCapture
AllowRebelGroundAttack
AllowRegisteredFunctions
AllowRGAOnUnowned
AllowScienceMissions
AllowShipCloning
AllowSuperRefit
AllowTowCloakedShips
AllowWebMines
AllowWormholes
AllowWraparoundMap
AlternativeAntiCloak
AntiCloakImmunity
B
BayLaunchInterval
BayRechargeBonus
BayRechargeRate
BeamFiringRange
BeamHitBonus
BeamHitFighterCharge
BeamHitFighterRange
BeamHitOdds
BeamHitShipCharge
BeamRechargeBonus
BeamRechargeRate
BorgAssimilationRate
C
ClimateDeathRate
ClimateLimitsPopulation
CloakedMineTravelSafeWarp
CloakFailureRate
CloakFuelBurn
CloakMineOddsWarpBonusX100
ColoniesBuildFighters
ColonistTaxRate
CPEnableAllies
CPEnableBigTargets
CPEnableGive
CPEnableJettison
CPEnableLanguage
CPEnableMessage
CPEnableRaceName
CPEnableRemote
CPEnableRumor
CPEnableSend
CrewKillScaling
CrystalSinTempBehavior
CrystalsPreferDeserts
CumulativePillaging
D
DamageLevelForCloakFail
DarkSenseRange
DefenseForUndetectable
DelayAllianceCommands
DeleteOldMessages
DisablePasswords
E
EngineShieldBonusRate
ExtMissionsStartAt
ExtraFighterBays
F
FactoriesForDetectable
FighterBeamExplosive
FighterBeamKill
FighterFiringRange
FighterKillOdds
FighterMovementSpeed
FighterSweepRange
FighterSweepRate
FilterPlayerMessages
FireOnAttackFighters
FreeFighters
G
GameName
GravityWellRange
GroundDefenseFactor
GroundKillFactor
H
HissEffectRate
HullDamageScaling
HullTechNotSlowedByMines
I
IonStormActivity
IonStormsHideMines
L
Language
LargeMeteorOreRanges
LargeMeteorsImpacting
M
MapTruehullByPlayerRace
MaxColTempSlope
MaxFightersLaunched
MaximumMinefieldRadius
MaxPlanetaryIncome
MaxShipsHissing
MeteorShowerOdds
MeteorShowerOreRanges
MineDecayRate
MineHitDamageFor100KT
MineHitOdds
MineHitOddsWhenCloakedX10
MineOddsWarpBonusX100
MineScanRange
MinesForDetectable
MineSweepRange
MineSweepRate
MineTravelSafeWarp
N
NativeClimateDeathRate
NativeCombatSurvivalRate
NativeTaxRate
P
PALAggressorKillPointsPer10KT
PALAggressorPointsPer10KT
PALBoardingPartyPer10Crew
PALCombatAggressor
PALCombatBaseScaling
PALCombatPlanetScaling
PALDecayPerTurn
PALGloryDamagePer10KT
PALGloryDevice
PALGroundAttackPer100Clans
PALImperialAssault
PALOpponentKillPointsPer10KT
PALOpponentPointsPer10KT
PALPillage
PALPlayerRate
PALRecyclingPer10KT
PALRGA
PALShipCapturePer10Crew
PlanetaryTorpsPerTube
PlanetsAttackKlingons
PlanetsAttackRebels
PlanetsHaveTubes
PlayerRace
ProductionRate
R
RaceGrowthRate
RaceMiningRate
RamScoopFuelPerLY
RandomMeteorRate
RebelsBuildFighters
RecycleRate
RGANeedsBeams
RobCloakedChance
RobCloakedShips
RobFailureOdds
RobotsBuildFighters
RoundGravityWells
S
SBQBuildChangePenalty
SBQBuildPALBoost
SBQNewBuildPALBoost
SBQPointsForAging
ScanRange
ScoringMethod
SensorRange
ShieldDamageScaling
ShipCloneCostRate
ShipMovementSpeed
SpyDetectionChance
StandoffDistance
StrikesPerFighter
StructureDecayPerTurn
T
TerraformRate
TonsScoreCountsPlanets
TorpFiringRange
TorpHitBonus
TorpHitOdds
TowedShipsBreakFree
TransuraniumDecayRate
TubeRechargeBonus
TubeRechargeRate
U
UnitsPerTorpRate
UseAccurateFuelModel
W
WebDrainFuelLoss
WebHitDamageFor100KT
WebMineDecayRate
WebMineHitOdds
WebMineOddsWarpBonusX100
WebMineSweepRange
WebMineSweepRate
WebMineTravelSafeWarp
WormholeUFOsStartAt
WraparoundRectangle
WrmDisplacement
WrmEntryPowerX100
WrmMassAdd
WrmRandDisplacement
WrmRandMass
WrmRandStability
WrmStabilityAddX10
WrmTravelCloaked
WrmTravelDistDivisor
WrmTravelWarpSpeed
WrmVoluntaryTravel

Back to the index


This document is maintained by The Portable Host Project (phost-support@umich.edu).
Last updated March 2, 1998