PCC2 Quick Documentation
This is a (really) brief overview over all functions of PCC2
and PlayVCR, until we have a help function.
It is current as of PCC2 Beta 4.
- Invocation
- PCC2 Screens
- PlayVCR Screens
Invocation
PCC2
Arguments can be options, a player number, or directories. Not
counting options, The following possibilities exist:
- pcc-v2 (no player number and directory): start with a
game chooser.
- pcc-v2 PLAYER GAMEDIR (player number and one directory):
play that PLAYER in GAMEDIR. Take ship list from GAMEDIR, and if
there is none, use defaults.
- pcc-v2 PLAYER GAMEDIR ROOTDIR (player number and two
directories): play that PLAYER in GAMEDIR. Take ship list from
GAMEDIR, and if there is none, from ROOTDIR.
You do not have to unpack your RST before playing.
If you don't, PCC2 will read the RST directly, and produce a TRN directly.
If you do unpack your turn, PCC2 will behave like a classic VGA Planets™ client and just modify .dat files;
you will then have to run Maketurn separately.
To play registered, place a fizz.bin file created by your registered client in the game directory,
just like you do with PCC 1.x.
pcc-v2 accepts all the common options.
PlayVCR
There are four ways to invoke PlayVCR.
- playvcr FILE (where FILE is a vcrX.dat file):
start playing this file.
Optionally, you can append a directory name to take the ship list from (default: same as the one containing the file),
and a battle number to start playing that battle.
- playvcr -sim [DIRECTORY]:
open battle simulator, using the ship list from the specified directory
(or the current directory, if no directory given)
- playvcr FILE.ccb (where FILE.ccb is a .ccb file):
open battle simulator and load the specified simulation setup.
Optionally, you can append a directory name to take the ship list from (default: same as the one containing the file).
- playvcr [-dir [DIRECTORY]]:
Start with file selection.
In addition to the options -sim and -dir, PlayVCR
accepts the common options.
Common Options
The following options are accepted by the graphical programs pcc-v2 and playvcr:
- -help: display help summary
- -charset EXT[:INT]: character set recoding.
EXT is the character set used by the host.
INT is the character set used by PCC2, and must correspond with the used fonts. It defaults to latin1.
The following character sets are supported:
- cp1250 (Eastern Europe Windows codepage)
- cp1251 (Cyrillic Windows codepage)
- cp1252 (Western Windows codepage)
- cp437 (Western DOS codepage, default for most VGAP stuff)
- cp850 (Western Europe DOS codepage)
- cp852 (Eastern Europe DOS codepage)
- cp866 (Cyrillic DOS codepage)
- koi8-r (Cyrillic Unix)
- latin1 (Western)
- latin2 (Eastern Europe)
- pcc1 (PCC 1.x character set, mostly the same as cp437)
- -display DPY (X11): set display to use. Same as setting the DISPLAY environment variable
- -fullscreen: run fullscreen
- -windowed: run in a window
- -bpp=N: set color depth to 8/16/32 bits per pixels
- -hw: use hardware surface (may be faster, but may not work at all)
- -size=WI[xHE]: set window size
- -resource=NAME: add another resource file (cc.res)
- -nomousegrab: don't grab the mouse pointer and confine it to the PCC2 window on the starchart.
By default, PCC2 grabs the mouse to support "infinite" movement.
This does, however, prevent you from switching to another task while at the starchart.
PCC2 Screens
Game Selector
Select a directory on the left. Available races will be shown on
the right. Change directory using the Change directory
button (or Enter while cursor is on directory list),
play game using Open game
button (or Enter while cursor is on race list). Use
Tab to switch between fields.
Race Screen
Unit selector
- Up, Down: browse through objects
- Ctrl-Up, Ctrl-Down: browse through marked objects
- .: mark/unmark current object
- Enter: select object
Control Screen
All control screens support similar keys.
- PgUp, PgDn: browse
- Ctrl-PgUp, Ctrl-PgDn: browse, accept only marked units
- .: mark/unmark unit
- F1: choose ship
- F2: choose planet
- F3, F8: choose base
- F4: go to starchart
- Shift-F1, Shift-F2, Shift-F3, Shift-F4, Shift-F8: go to ship/planet/base/starchart location at this point
- Ctrl-F1, Ctrl-F2, Ctrl-F3, Ctrl-F4, Ctrl-F8: go to ship/planet/base/starchart location at other end of scanner
- X: go to unit at other end of scanner
- F5, Shift-F5: information about planet here
- Ctrl-F5: information about planet at other end of scanner
- F9: edit this unit's comment
- Shift-F9: edit comment of planet here
- Ctrl-F9: edit comment of planet at other end of scanner
- L: list ships at other end of scanner
- Y: enable keyboard-move-scanner mode. Move scanner around with arrows, exit with ESC.
- Backspace: go to previous screen
- Alt-Backspace: show list of previous screens
- Ins: add unit to battle simulation
Ship Screen
The following keys are supported in addition to Control Screen keys.
- N: change ship's name
- M: change ship's mission
- E: change ship's primary enemy
- A: change ship's waypoint. See Navigation Chart
- C: cargo transfer
- B: open menu listing starbase commands applicable to this ship.
- Ctrl-J: review Jettison order
- Ctrl-S: review transfer-to-enemy-ship order
- Ctrl-P: review unload-to-planet order
- U: cargo transfer to planet
- F: change ship's friendly code
- W: change ship's warp speed
- Ctrl-W: change ship's waypoint to match the scanner
- Ctrl-I: go to ship whose Id is in this ship's mission's Intercept parameter (i.e. go to ship we're intercepting)
- Ctrl-T: go to ship whose Id is in this ship's mission's Tow parameter (i.e. go to ship we're towing)
- Tab: cycle through ships at this place. With Ctrl: marked ships only. With Shift: backward
Planet Screen
The following keys are supported in addition to Control Screen keys.
Base Screen
The following keys are supported in addition to Control Screen keys.
Starchart
- Use the arrows to move around in steps of 10. Hold Shift to go a single light year, Ctrl to go 100.
- +, -: zoom
- Space: lock onto planet. With Ctrl, only marked units
- Enter: lock onto ship. With Ctrl, only marked units
- F1: go to ship screen (if locked at a ship)
- F2: go to planet screen (if locked at a planet)
- F3, F8: go to base screen (if locked at a planet with base)
- F4, ESC: exit starchart
- F5: planet information (if locked at a planet)
- F9: edit current unit's or marker's comment
- Shift-F9, Ctrl-F9: edit current planet's comment
- Alt-F9: edit current marker's comment
- Tab: cycle through units at this place. With Ctrl, only marked units. With Shift, go backwards.
- PgUp, PgDn: browse through units of this type in Id order. With Ctrl, only marked units. With Shift, also include units we're not playing
- L: list ships at this point
- M: minefield information
- U: Ufo information
- C: change color of drawing near cursor
- V: move marker we're locked on. Finish moving with ESC
- P: draw
- D: distance meter
- Del: delete drawing near cursor. Confirm with Enter or Y, cancel with ESC or N.
Pick different drawing to delete using Del. Delete this line and all adjacent lines using A.
- Backspace: go to previous screen
- Alt-Backspace: show list of previous screens
- Alt-M: toggle display of minefields
- Alt-A: toggle display of ships as dots or triangles
- Alt-D: toggle display of unit labels
- Alt-I: toggle display of ion stormes
- Alt-V: toggle display of ship vectors [not yet implemented]
- Alt-T: toggle highlight of marked units
- Alt-S: toggle display of sector borders
- Alt-B: toggle display of map borders
- Alt-U: toggle display of Ufos
- Alt-P: toggle display of drawings
- Alt-W: toggle display of warp well boundaries
Read Messages
- Up, Down: browse
- Shift-Up, Shift-Down: browse, don't skip hidden messages
- S: search for text
- N: continue search
- F: forward to another player
- Tab: subject overview. Messages of similar content are collapsed to one line, for quicker navigation.
On the overview list, press K to hide/show a particular group.
Messages in this group will be skipped by default.
- ESC: exit
Write Messages
Choose races to send message to, or U to send a universal message (to everyone).
You'll be placed in the message editor.
- Arrows move around.
- Enter: start new line
- Ctrl-Y: delete line
- F10: send message
Scores
PCC2 records current and past scores in a file score.cc.
It records the standard score as well as all additional scores it receives from PHost through util.dat.
At the time of this writing, those are minefield limits and counts.
- Left, Right: choose between different views
- Ctrl-Up, Ctrl-Down (overview), Ctrl-Left, Ctrl-Right (charts): choose race to highlight
- D (overview): choose different display mode:
- Normal scoreboard
- Differences to previous turn (each turn vs. its predecessor)
- Differences to turn X (each turn vs. turn X)
- Percentages (relative strength compared to highlighted race, which is taken as 100%)
- Ratio of total (relative strength compared to all races together)
- Shortcuts for individual pages are assigned dynamically.
Battle Simulator
- Ins: add new ship (asks for hull type, assigns default owner).
- Ctrl-Ins, *: replicate current ship.
- Del: remove this ship.
- F1: show this ship on ship screen if possible
- Ctrl-Up, Ctrl-Down: move ship up/down (has no effect on simulation)
- U: update this ship's simulation data with information from game
- Ctrl-U: update all ship's simulation data with information from game
- W: write this ship's simulation data to game
- Ctrl-W: write all ship's simulation data to game
- A: edit aggressiveness (PE, Kill)
- T: edit hull type
- F: edit friendly code
- Shift-F: move to next ship, and give it a numeric fcode above the previous ship's code
- 1: edit primary weapon (beams)
- 2: edit secondary weapon (torpedoes, fighters)
- N: edit name
- I: edit Id number
- D: edit damage
- S: edit shield level
- M: edit mass (custom ships only)
- C: edit crew
- L: edit experience level (if active on your host)
- O: edit owner
- E: edit engine (for engine/shield bonus computation)
- V: toggle cloak status
- R: toggle random friendly codes. When enabled, the friendly code will be set to a random numeric value before the simulation. You can choose to randomize some digits only by assigning a friendly code containing "#".
- .: temporarily disable ship (remove from simulation without deleting it) or enable it again
- X: edit intercept target (for Intercept Attack battle order)
- B: edit abilities (hullfuncs). Abilities relevant to simulation are FullWeaponry, Commander, and PlanetImmunity. You can enable or disable each function, or let the simulator use the default (taken from the ship list, considering the ship's type, owner and experience level).
- P: edit planet
- Ctrl-O: edit options
- Ctrl-R: read saved simulation from a file (.ccb)
- Ctrl-S: save simulation setup to file
Battle Simulator Planet Editor
- N, I: select planet Id
- O: edit owner
- F: edit friendly code
- D: edit defense post count
- P: edit population (and compute maximum defense post count from that)
- B: edit base beam tech. 0 means no base
- G: edit base fighter count
- S: edit base defense count
- T: edit base torp tech
- W: edit base torpedoes. You can enter a count for each type.
Battle Simulator Options
- E: edit engine/shield bonus (should correspond to Host setting)
- C: toggle Fed Crew Bonus (should correspond to Host setting)
- R: toggle random left/right side assignment. PHost does this, THost doesn't.
- L: choose balancing mode for THost left/right imbalance. Default implemented in THost is "360 kt", PHost doesn't need this and has "none"
- P: choose host/VCR version
- A: choose whether to honor alliances [unimplemented]
- B: set to "one" to limit simulations to one fight per battle. Default is to simulate all
- S: toggle seed control. If enabled, a "series" (see Simulator Result) is guaranteed to simulate all possible results; if disabled, random battles are simulated. Only supported for one-fight THost battles.
- F: choose whether random friendly codes are applied when you start the simulation with Enter, or for each simulated battle.
Battle Simulator Result
The simulator result screen displays simulation results. The "Totals" tab
has results grouped by class and probability (e.g. "2 Feds surviving: 10x, 1 Borg surviving: 2x").
The "Details" tab has information about each unit.
- Space: run one simulation
- S: run one series. With seed control enabled, this will simulate all possible results exactly once. A second series will yield the same result as the first one. Otherwise, just simulates 110 random battles.
- R: repeat indefinitely, until cancelled with a key
- Enter: watch sample
- E: close result screen and place cursor on current ship
VCR
Choose fight using arrows, press Enter to play it.
During playback, use the following keys:
- Right: play/pause
- Shift-Right, Shift-Left: move single frame
- Ctrl-Right, Ctrl-Left: move 20 frames
- Alt-Right, Alt-Left: go to end/beginning
Friendly Code
As a little help, PCC2 knows special friendly codes and offers
you them on a list. Note that the list also contains a friendly
code ???, which is not special to host. However, the
simulator treats it as an exception to the
"same fcode, no fight" rule, so you don't have to come up with
individual fcodes for completely made-up fights.
- Tab: switch between input and list
- Alt-R: pick a random friendly code that
has no special meaning
Navigation Chart
- Use the arrows to move around in steps of 10. Hold Shift to go a single light year, Ctrl to go 100.
- +, -: zoom
- Space: lock onto planet
- Enter: lock onto ship
- F10: confirm
Cargo Transfer
After choosing the target (if applicable), the Cargo Transfer window displays the unit you started with on the left, and the target on the right.
- Up, Down: choose kind of cargo to transfer
- Left, Right: move 10 units. With prefix argument, move that many
- Shift-Left, Shift-Right: move 1 unit
- Ctrl-Left, Ctrl-Right: move 100 units
- Alt-Left, Alt-Right: move as much as possible. With prefix, move as many to make the left/right unit have exactly that many.
- U: if one unit is a planet, move all T/D/M/$/Sup/Colonists to that unit
- S: if one unit is a planet, toggle automatic supply sale. Supplies you move off one unit appear as megacredits on the other
Buildings
- Up, Down: choose type of building
- Left, Right, Tab: choose view. PCC2 offers three build screens. On each you can build a different selection of structures, and you see a different amount of useful information
- +: build one structure (with prefix: build that many)
- -: scrap one structure (with prefix: build that many). You can only scrap what you've built this turn.
- T: Taxes
- S: sell supplies
- A: auto build
- G: edit autobuild goals
Taxes
If the planet has natives, use Tab to switch between natives and colonists.
Use + and - to choose tax rates.
Sell Supplies
The "Sell Supplies" dialog will ask you how many supplies you want to sell.
It will sell the supplies when you confirm with Enter.
You can also enter the number of supplies you want to keep and confirm with A.
Auto Build
For each planet, you can define a target count and speed for each structure type.
When ordered to perform automatic building, PCC2 will sort those values by speed, highest first.
It will then try to build as many structures as the speed says, stopping only when the goal has been reached or rules don't allow building more.
It will then proceed with the second structure, etc.
If all structures have been processed, the cycle starts again, until nothing more can be built.
As a special exception, PCC2 will make sure there's at least one factory, even if you ordered it to build mines first.
By default, goals are 1000 (meaning "infinite"), and speeds are 5 for mines, 10 for factories,
and 3 for defense posts.
This means that auto build will try to build 10 factories, then 5 mines, then 3 defense posts.
If you have lots of money, this means that PCC2 will build twice as many factories as mines.
If you have little money, this means PCC2 will first build up factories before starting with mines.
To disable auto build for one structure, set its goals and/or speeds to zero.
Building Ships
The ship building dialog has four tabs.
Choose the hull type on the first tab, further components on the other three tabs.
You can choose components you don't yet have the right tech for, PCC2 will then include the tech level
cost in the bill displayed below, and automatically upgrade tech as appropriate.
For beams and torpedoes, you can choose how many components to put into your ship using + and -.
- Enter: confirm build; modifies the build order to build this ship
- ESC: cancel, do not change the build order
- C: cancel current build order
- Space: build or scrap individual components (for Super Refit)
Drawing
PCC2 can draw four kinds of items into the starchart:
- Polygons, sequences of lines
- Rectangles
- Circles
- Markers, little symbols
If you want to draw a marker, PCC2 will prompt you for shape and color, and draw that marker
into the starchart.
For the other types, you'll be dropped back in the starchart, and a new shape starting here will be begun.
- Regular starchart movement keys are accepted.
- +, - (circle): change radius in steps of 10. With Shift, in steps of 1.
- Y (circle): make radius 350 ly
- + (line): finish line and start next one
- Backspace: go back to starting point
- X (line, rectangle): swap start and end point
- ESC: finish
Distance Meter
- Regular starchart movement keys are accepted.
- X: swap start and end point
- Backspace: go back to starting point and exit distance meter
- ESC, D: finish
Prefix Argument
At some places, PCC2 accepts a prefix argument which modifies the following keystroke.
Normally, this is used to set the amount you wish to build, move, etc.
To use a prefix argument, just start by typing a number.
A yellow popup will appear.
Keep typing, and confirm by pressing the key whose function you wanted to perform.
For example, to build 15 factories on the Buildings screen,
you'd type 15+.
- Backspace: correct typos
- *: multiply. Enter 3*3 for a prefix argument of 9
- /: divide. Enter 20/4 for a prefix argument of 5
- ESC: cancel prefix argumetn
PlayVCR Screens
File Selector
Select a directory on the left. Available VCR files will be shown on
the right. Change directory using the Change directory
button (or Enter while cursor is on directory list).
Play VCRs using View VCRs
button (or Enter while cursor is on race list). Use
Tab to switch between fields.
- F2: sound configuration. Enable or disable sound and tune some knobs.
- F3: general configuration. Allows you to disable instant battle result if that spoils your fun.
- F4: simulator
VCR Selector
Choose fight using arrows, press Enter to play it.
Press F to get back to file selector.
Actual playback works identical to PCC2.
[ PCC2
| PCC 1.x
| My VGA Planets Page
]
Stefan Reuther
Last modified: Sat May 30 19:28:49 CEST 2009