Coffee Chinese Chess

I. How to use Coffee Chinese Chess Applet

1. Unzip coffeecc.zip which contains

• coffeecc.jar (Need to upload this file to your web site)
• piece.gif (Need to upload this file to your web site, you may choose other from directory demo)
• audio/*.au (Sound files - need to upload all directory. Otherwise, the game will have no sound. You may delete or modify some of them. For example, if you do not want sound in background, delete file background.au)
• demo/*.* (Directory containing peace and board pictures for demo, you may choose the best one for your web site)
• cccmain.htm (Main HTML file - open it first for instruction and demos)
• ccc*.htm (Some other HTML files for instruction and demos)
• coffeecc.gif (Logo of this game)
• game*.txt (Some examples of games written in WXF format for program loading)

Do not unzip the jar file, nor add any other files into it (because some browsers like Netscape could work faultily).

2. Upload coffeecc.jar, piece.gif, sound directory to your web site.

3. Add following code to your html (the simplest sample HTML source):

Sample HTML source 1:

<applet archive="coffeecc.jar" code="coffeecc.class" width="450" height="370">
</applet>

4. Customize parameters as the following part.

II. Setup parameters

Note:

• The default values of parameters are good in normal cases. You need not do anything for them. Those default values will make you work more easily. Use as many as possible.
• Some parameters can be set by one of two or three names, as well as their values. Choose the most convenient.
• There are some ways to do the same work (e.g. set up the initial board). Choose the most convenient.
• Some parameters totally compatible to some other viewers, like chessviewer, xqviewer.
• Beware when you set some parameters, your users may not be able to setback to their preferred ones. For example, if you turn off all control panels, there is no way to undo or redo moves.
• You can write any integer number in decimal or hexadecimal or octal form.
• You may need to re-size applet after setting up new parameters.

Parameter tables:

Parameters for appearances

Parameters for setting players

Parameters for setting game levels

Parameters for opening book

Parameters for input game

a) Details of parameter position

This parameter is used for setting up initial positions of all 32 pieces. Each piece is represented by two characters, the first for column and the second for row.
The normal start position for all 32 piece is 

<param name="position" value="A0B0C0D0E0F0G0H0I0B2H2A3C3E3G3I3A9B9C9D9E9F9G9H9I9B7H7A6C6E6G6I6">

For disabling any piece at startup, change that piece position to "Z0". For convenience, you may add spaces and commas to separate pieces.

b) Details of parameter board

This parameter is used for setting up initial 90 positions of board. Pieces are represented by characters: K, R, C, H, E, A, P, k, r, c, h, e, a, p - the initial characters of King, Rook, Cannon, Horse, Elephant,  Advisor, Pawn, lower case characters for blue side, and upper case for red side. The empty position is written by a dot (.).
For convenience, you may add spaces and commas to separate pieces.

For example:

<param name="board" value="....ka...,....a....,P...e....,.........,........H, .........,......r..,.........,...RA....,....KA...,">

c) Details of parameter piece

This parameter is used for setting up initial positions of the existing pieces. Pieces are represented by:

• One of characters: K, R, C, H, E, A, P, k, r, c, h, e, a, p (the initial characters of King, Rook, Cannon, Horse, Elephant,  Advisor, Pawn, the lower case characters for blue side, and the upper case for red side).
• Two characters for position, the first for column and the second for  row.

For convenience, you may add spaces and commas to separate pieces.

For example:

<param name="piece" value="Ke0 Pf5 Ch5 Re6 kf8 ci7 rc3 rh2">

d) Details of parameter movelist
The format of each move step either P1+1[comment] for WXF or B2-E2[comment] for ICCS. If you do not need comment, simply let it blank or remove both brackets.

The move list may be long, but do not break in the middle of the move list. For convenience, you may add spaces and commas to move list.

If you need to display more than one move list, name the second movelist1, third movelist2 and so on. For using them, turn on the answer button.

For example:

<param name="movelist" value="C8.5,C4.3,C6+7,R2+3,C6.3,P3+1,K5.6,P3.4[Good game]">

e) Details file format for parameter wxffilename

The above methods for input of a game may be not flexible for your home page, where you need to update a new game frequently. This method could be more relevant. When updating a new game, you need to upload only one small text file, following the WXF notation. You could see examples of game1.txt, game2.txt and game3.txt and see example of demo of some purposes.

III. Some sample HTML sources

a. Sample HTML source 2 - turn on the sound, change color of board:

<applet archive="coffeecc.jar" code="coffeecc.class" width="450" height="370" >
<param name="sound" value="on">
<param name="boardbackgroundcolor" value="0xffff00">
<param name="boardforecolor" value="0xff">
</applet>

b. Sample HTML source 3 - turn off all control panel, change one picture file of pieces and use the other for board:

<applet archive="coffeecc.jar" code="coffeecc.class" width="370" height="420" >
<param name="controlpanel" value="0">
<param name="pieceimage" value="demo/piece2d.gif">
<param name="boardimage" value="demo/board2d.gif">
</applet>

c. Sample HTML source 4 - set up game information, turn off notation tag and copyright line:

<applet archive="coffeecc.jar" code="coffeecc.class" width="430" height="406">
<param name="gameinfo" value="THE WORLD CHINESE CHESS CHAMPIONSHIP">
<param name="gameinfoforecolor" value="0x80">
<param name="notationtag" value="off">
<param name="redplayer" value="World Champion Challeger">
<param name="blueplayer" value="World Champion">
<param name="copyright" value="off">
</applet>

d. Sample HTML source 5 - set up a puzzle and answer:

<applet code="coffeecc.class" width="440" height="350">
<param name="copyright" value="0">
<param name="sound" value="on">
<param name="controlpanel" value="1">
<param name="ply" value="9">
<param name="answer" value="1">
<param name="startbutton" value="0">
<param name="piece" value="Ke0,Cg4,Ha5,Ci5,Pb6,Pf8,Ri8,ad9,ke9,ch9,ae8,rh6,pe5,pi4,pg2,pf1,pb0">
<param name="movelist" value="R1.2,R8-2,C1+4 A5-6,C3+5A6+5,C3-6A5-6,C3.5A4+5, P4+1K5.4,P4.5K4+1,H9+7K4+1,H7+8K4-1,C1-1P2.3,H8-7K4+1,H7-5K4-1, C5.6P3.4,K5.6R8.9,H5+7K4+1,H7-6K4.5,H6+4K5.4,P8.7K4-1,H4-6A5+4,H6+5K4.5,C6.5">
<param name="pieceimage" value="images\2dsmall.gif">
<param name="boardbackgroundcolor" value="0xffffff">
<param name="boardforecolor" value="0xb0b0bb">
</applet>

e. Sample HTML source 6 - Read content of a game from file:

<applet archive="coffeecc.jar" code="coffeecc.class" width="360" height="311" >
<param name="pieceimage" value="demo/piecesmall.gif">
<param name="movebegin" value="15">
<param name="controlpanel" value="2">
<param name="blueplayerkind" value="0">
<param name="startbutton" value="off">
<param name="copyright" value="0">
<param name="wxffilename" value="game1.txt">
</applet>

Go to my home page
Email: Pham Hong Nguyen