PCC2 Preferences File
======================

  PCC2 stores its settings in a special directory.
  - under Unix, there is a ".pcc2" directory in your home directory
  - under Windows, there is a "PCC2" directory in your your profile's
    application data folder, for example, "C:\Documents and Settings\
    user\Application Data" under Windows XP.

  This directory contains the main preferences file, pcc2.ini. For
  backward compatibility, PCC2 also looks for pcc2.ini directly in
  your home / application data folder, which was the exclusive location
  until 1.99.12.

  pcc2.ini is a text file. It contains assignments of the form
  "key=value", like most ".ini" files. PCC2 understands the following
  values. Some are accessible through the user interface, some are not.

  Since 1.99.19, PCC2 also looks for a pcc2.ini in game directories.
  Settings from the game directory configuration file override those from
  your global file. The global file always contains all settings, the
  per-game file contains only the per-game settings.

  For some settings, only one particular location makes sense, so PCC2
  automatically picks the right location. For others, you can choose
  the location.


Backup.Chart (string)
Backup.Result (string)
Backup.Script (string)
Backup.Turn (string)
Backup.Util (string)
Maketurn.Target (string)

  These options configure path names for the automatic backup function.

  Each option contains a file name template that can contain the following
  placeholders:

  - %d: full game directory name if first component of the name, otherwise
    final component of game directory name
  - %t: turn number with three digits
  - %p: player number with one or two digits

     Backup.Chart     chartX.cc, upon save of game
     Backup.Result    playerX.rst, upon unpack or open
     Backup.Script    scriptX.cc, upon save of game
     Backup.Turn      playerX.trn, upon creation (maketurn/save)
     Backup.Util      utilX.dat, upon unpack or open
     Maketurn.Target  playerX.trn, upon creation (maketurn/save)

  Note that there are two options for the turn file. They are technically
  equivalent but have different purpose: Backup.Turn is intended for turn
  file backups and should contain a value like "%d/backups/turn%p.%t".
  Maketurn.Target is intended for automatic copying in local games and
  could contain a value like "c:\host\mygame\player%p.trn".


Chart.AnimThreshold (integer, default: 11)

  Configures the starchart movement animation. If the starchart is
  moved by an amount less than this value given in game coordinates (light
  years), it is moved directly (without animation). If it is moved by a
  larger value, the animation is used. PCC2 accepts integral values between
  0 and 10000. Examples:

  - 0 (always animate, even small steps)
  - 11 (default: movement using the arrow keys is not animated, but
    larger movement is)
  - 10000 (never animate, like in PCC 1.x)

  If you have a slower computer, you may want to set this to 10000.


Chart.Circle.Outside (integer, default: 501)

  Circular wrap tweak:

  Defines the size of the "outside" part of the map in circular-wrap
  mode. You can raise or lower it according to your needs. Higher
  values increase the size of the seam, giving you more room to see
  outside at the expense of performance.

  PCC 1.x equivalent: Chart.Outside


Chart.Circle.Precision (integer, default: 2)

  Circular wrap tweak:

  In a circular-wrap map, the mapping from "inside" to "outside" of
  the map is not always reliable. For some inside points, PCC has to
  search the equivalent outside points. This option defines the range
  of the search and thus the "precision" used to build the "outside"
  map image.

  With the current formulas, PCC should never need precision larger
  than 1 (it did with the original version of the formula); the option
  remains just in case. Note that there can be positions which do not
  have an outside counterpart, so no matter how large you make the
  precision, PCC will not find the correct place.

  PCC 1.x equivalent: Chart.Precision


Chart.Geo.Center (2 integers, default: 2000,2000)
Chart.Geo.Size (2 integers, default: 2000,2000)
Chart.Geo.Mode (enum)

  These configure the starchart geometry.

  - Chart.Geo.Mode: defines the mode; one of: "flat", "wrapped", "circular"
  - Chart.Geo.Center: defines the center of the map
  - Chart.Geo.Size: defines the size (width/length for wrapped, radius for
    circular; for circular, both values must be the same).

  PCC 1.x equivalent: Chart.DimX, Chart.Wrap


Chart.Marker0-9 (2 integers + 1 string)

  This option configures canned markers. It consists of two integers and
  one optional string, separated by commas, as in "Chart.Marker1 = 1,9,Name".
  The second comma must be present even if the string is empty.

  The first integer is the marker shape, the second integer is the marker
  color, as for the NewMarker script command. The string is the description
  shown on the configuration dialog; if it is empty, PCC2 displays a
  default.

  PCC 1.x equivalent: MarkerX


Chart.MouseStickiness (integer, default: 5)

  When locked at an object in the starchart, PCC2 requires you to move the
  mouse at least this distance before moving the cursor off the object.
  This avoids that unintended movement (such as a truck passing by your
  house and shaking your desk) loses the object lock by accident. You can
  increase this value for higher protection, or lower it for less
  stickiness.

  - 0 (absolutely no stickyness, same as PCC 1.x)
  - 1 (minimum stickiness)
  - 5 (default)
  - 20 (high safety; much higher values are not practical)

  This value does not affect keyboard movement.


Chart.Normal.Show (item list)
Chart.Small.Show (item list)
Chart.Scanner.Show (item list)

  Configures what elements are shown on the starchart in normal-size,
  reduced-size, and control-screen starcharts, respectively. The value
  is a comma-separated list of items to show:
  - "ion" (show ion storms)
  - "mine" (show mine fields)
  - "ufos" (show ufos)
  - "sectors" (show sector borders)
  - "borders" (show map borders, in wrapped maps)
  - "drawings" (show drawings)
  - "selection" (show selection, yellow crosses)
  - "labels" (show user object labels)
  - "trails" (show ship trails)
  - "shipdots" (show ships as dots, not triangles)
  - "warpwells" (show warp well outlines)

  PCC 1.x equivalent: Chart.FlagsX


Chart.Normal.Fill (item list)
Chart.Small.Fill (item list)
Chart.Scanner.Fill (item list)

  Like Chart.*.Show, this configures what elements are filled on the
  starchart in normal-size, reduced-size, and control-screen
  starcharts, respectively. The setting obviously takes effect only
  when the object is also shown. The value is a comma-separated list
  of items to fill:
  - "ion" (show ion storms)
  - "mine" (show mine fields)
  - "ufos" (show ufos)

  PCC 1.x equivalent: Chart.FlagsX


Chart.Scanner.WarpWells (boolean, default: off)

  By default, clicking into a scanner places the cursor onto the
  nearest object; using Shift optimizes for warp wells.

  When this option is enabled, the meaning is reversed: clicking into
  a scanner optimizes for warp wells, use Shift-click to use an exact
  point.


Display.Clans (boolean, default: off)

  By default, PCC2 often displays populations as actual colonist counts
  ("Population: 50,000"). With this option enabled, PCC2 will display
  clans ("Population: 500c").

  Note that even with this option disabled, PCC2 displays clans at some
  places, most notably cargo transfer.


Display.ThousandsSep (boolean, default: on)

  When enabled (default), large numbers are displayed with a
  thousands-separator ("5,120,000" instead of "5120000").


Export.PlanetFields (string list)
Export.ShipFields (string list)

  These configure the last field sets used for the Export function. Each
  entry has same format as the "-f" option to c2export.

  PCC 1.x equivalent: Export.Planet, Export.Ship


Label.Planet (string)
Label.Ship (string)

  Expressions used to label planets and ships, respectively.

  PCC 1.x equivalent: Chart.LabelX


Lock.Left (item list)
Lock.Right (item list)

  In the starcharts, mouse buttons lock onto objects. These settings
  configure on which ones.
  - "planet"
  - "ship"
  - "ufo" (including wormholes)
  - "marker" (including explosions)
  - "minefield"


Messages.CollapseOld (boolean, default: off)

  If enabled, old messages are collapsed to one entry in the message
  subject overview.


Messages.RewrapInbox (boolean, default: on)

  Some combinations of client and host-side software produce garbled
  messages. By default, with this option enabled, PCC2 reformats
  incoming messages to recover the formatting. If this makes problems,
  this feature can be turned off.


Scanner.TieWaypoint (boolean, default: off)

  If enabled, the waypoint is tied to the scanner beam; every move to
  the scanner beam on the ship screen also sets the waypoint (like in
  planets.exe).

  By default, the two are separate, and setting the waypoint requires
  a double-click.


Sim.DefaultMode (enum, default: Host; PlayVCR only)

  Specifies the default simulation mode used by PlayVCR when no host
  configuration is found. Possible values are "Host", "PHost2", "PHost3",
  "PHost4", "FLAK", "NuHost".


Sort.Ship (integer, default: 0)

  Sort order for ships on the visual scanner list, and for the "Tab"
  key on the ship screen.

      0           Id
      1           Owner
      2           Hull
      3           Mass
      4           Fleet
      5           Tow Group
      6           Battle Order
      7           Location
      8           Hull Mass
      9           Damage
     10           Name


Sound.16Bits (boolean, default: on)

  If enabled (default), sound is produced with 16 bit samples. If
  disabled, 8-bit samples are produced. Unless you have a very old
  sound card, you don't have to change this.


Sound.Enabled (boolean, default: on)

  Toggles whether PCC2 produces sound or not. You may want to disable
  this if it interferes with other programs, which happens with then
  suboptimal sound card drivers.


Sound.Frequency (integer, default: 22050)

  Configures the mixing frequency. Higher values produce higher system
  load. Possible values depend on your sound card. If your card does
  not support a particular value, PCC2 uses one which works.


Sound.Headphone (boolean, default: off)

  If enabled, PCC2 shifts stereo sound a little forward for headphone
  users.


Sound.Reverse (boolean, default: off)

  If enabled, PCC2 swaps left and right channel of sound output.


Sound.Stereo (boolean, default: on)

  If enabled, PCC2 produces stereo sound. This means, if the left unit
  in VCR fires a laser, the sound effect will be produced on the left
  speaker.


Tax.PredictRelative (boolean, default: off)
Tax.PredictRatio (boolean, default: off)

  Determines how growth and experience preditions on the taxation
  dialog are shown.

  - Tax.PredictRelative=No (default): absolute values
  - Tax.PredictRelative=Yes: relative values/change
    - Tax.PredictRatio=No (default): absolute change
    - Tax.PredictRatio=Yes (default): relative change (percentage)


Team.AutoSync (boolean, default: on)

  When enabled, PCC2 automatically synchronizes teams and alliances:

  When you offer an alliance to someone, they are placed in your team. 
  If someone is in your team whom you have not offered an alliance,
  they are removed.


Unpack.FixErrors (boolean, default: yes)

  If enabled, PCC2's unpacker will fix some errors in the RST file
  that can cause programs to stumble. If disabled, files will be
  unpacked unchanged.

  PCC2 works equally well with either setting. This option is
  equivalent to the c2unpack option "-n".


Unpack.Format (enum, default: Windows)

  This option selects the local game directory format produced by the
  unpacker. It can take the values
  - "Windows" (compatible with Winplan)
  - "DOS" (compatible with planets.exe)

  PCC2 works equally well with either format. This option is
  equivalent to the c2unpack option "-d"/"-w".

  PCC 1.x equivalent: Unpack.Format


Unpack.Source (string)

  not implemented as of 20130904.


Unpack.TargetExt (boolean, default: no)

  If enabled, PCC2's unpacker will create TARGETx.EXT files. Normally,
  the TARGETx.DAT file can only contain 50 visual contacts. Various
  ways to overcome this limitation have been developed over time. With
  this option enabled, PCC gathers the targets and splits them into a
  TARGETx.DAT and TARGETx.EXT file. If this option is disabled, files
  will be unpacked unchanged.

  PCC2 works equally well with either setting. This option is
  equivalent to the c2unpack option "-t".


VCR.InstantResult (integer, default: 1)

  Note that this currently is an integer, although it can take only
  two values, 0 (=disabled) and 1 (=enabled). When this option is
  enabled, PCC2 displays the battle result on the VCR selection
  window. Disable if you think this spoils your fun watching the
  battle.


VCR.Speed (integer, default: 2)

  VCR playback speed. Smaller is faster.

