1/* $Id: README,v 1.17 2004/06/02 02:10:24 slothman Exp $ */ 2 3JChessBoard 4 5Copyright (C) 2000-2002 Claus Divossen <claus.divossen@gmx.de> 6 7 8Table of contents: 9 101. About 112. Requirements 123. How do I start it? 134. How do I compile it? 145. Usage 156. Planned features 167. Known Bugs 17 18 191. About 20 21 JChessBoard is a chess board written in Java that can be connected 22 to another JChessBoard via a direct TCP/IP connection. No Internet 23 Chess Server is required for playing. It also became a full featured 24 PGN viewer and editor. 25 26 This is not a Java applet, it cannot run in a browser. It is a 27 stand alone Java application. 28 292. Requirements 30 31 The only requirement to use JChessBoard is a working JRE or JDK, 32 version 1.2.2 or greater. A JDK/JRE version 1.3 or greater is recommended. 33 34 353. How do I start it? 36 37 If you didn't compile it yourself, you need to use the delivered jar file. 38 39 Using a JRE only: 40 41 jre -jar JChessBoard.jar 42 43 Using a JDK: 44 45 java -jar JChessBoard.jar 46 47 On a windows machine, a double click on the jar file might work, too. 48 49 504. How do I compile it? 51 52 You will need a working JDK of course, version 1.2.2 or greater. 53 54 If you have Java build tool "ant": 55 56 Just go the the directory with the build.xml file and type: 57 58 ant 59 60 This will do all the necessary steps and generate the .jar file. 61 62 Otherwise: 63 64 Change to the directory above the jchessboard directory and enter: 65 66 javac jchessboard/JChessBoard.java 67 68 This should generate all required .class files. You can start this 69 compiled version with: 70 71 java jchessboard/JChessBoard 72 73 (Giving the name without the .class extension!) 74 75 After successfull compilation, the jar file can be created with: 76 77 jar cmf Manifest JChessBoard.jar jchessboard/*.class images/* 78 79 Note: All .java files have to be in the directory jchessboard, 80 because they all belong to the package jchessboard. 81 825. Usage 83 84 Network Games 85 86 To connect to another JChessBoard, just click "Connect..." in the File 87 menu. The JChessBoard server will be running by default, unless changed 88 in the "Server settings..." menu. 89 90 Incoming connections can be accepted or rejected. If you accept the new 91 connection, you can optionally open a new window for that connection to 92 keep the state of your current board. 93 94 The board will be newly initialised after connecting. Each subsequent move 95 will be transmitted to the other JChessBoard. 96 97 Only the figures of your side can be moved, the first move decides what 98 side that will be. 99 100 1016. Planned features 102 - help 103 - tutoral: The Laws of Chess, F.I.D.E 1997 104 - Other connectors: ICS 105 - Applet version. Because of security restrictions, an applet is not 106 able to connect directly to another applet. Still usefull if you 107 want to play against the AI, or for two players using one JChessBoard, 108 or as PGN browser. 109 - Improved AI: Smaller memory footprint, opening database, better timeout 110 algorithm, difficulty levels. But the AI is not the main focus of 111 that game, I made it just for fun. 112 - Board editor 113 - Interactive notation pane 114 - Toolbar 115 - Game upload to peer. 116 - Suggestions? 117 1187. Known Bugs 119 - The game may block while waiting for a connection. 120 121Any feedback is welcome. 122 123Enjoy! 124 125