settlers 0.2.1 → 0.3.0

data/{resources/jsettlers-1.0.6 → data/settlers/jsettlers-1.1.09}/README.txt

@@ -11,16 +11,14 @@ opponents. Initially created as an AI research project.
 The client may be run as a Java application, or as an applet when
 accessed from a web site which also hosts a JSettlers server.
 
-The server may be configured to use a MySQL database to store account
-information.  A client applet to create user accounts is also
-provided.
+The server may be configured to use a database to store account
+information (details below).  A client applet to create user accounts
+is also provided.
 
 JSettlers is an open-source project licensed under the GPL. The
-software is maintained as a SourceForge project at
-http://sourceforge.net/projects/jsettlers.
-
-Forums for discussions and community based support are provided at
-SourceForge.
+software is hosted at http://sourceforge.net/projects/jsettlers2
+and at http://nand.net/jsettlers/devel/ .  Questions, bugs, and
+patches can be posted at the sourceforge page.
 
                           -- The JSettlers Development Team
 
@@ -54,18 +52,20 @@ Requirements
 ------------
 
 To play JSettlers by connecting to a remote server you will need the
-Java Runtime Version 1.1 or above (1.4 recommended). To connect as an
-applet, use any browser which is Java enabled (again, we recommend
-Java 1.4 using the browser plug-in).
+Java Runtime Version 1.4 or above (1.5 or later recommended). To connect as an
+applet, use any browser which is Java enabled (using the browser plug-in).
+
+To Play JSettlers locally you need the Java Runtime 1.4 or above.
+JSettlers-full.jar can connect directly to any server over TCP/IP
 
-To Play JSettlers locally you need the Java Runtime 1.4 (or
-later). Remote clients started on the command line can connect
-directly to this server. To host a JSettlers server and provide a web
-applet for clients, you will need an http server such as Apache's
-httpd, available from http://httpd.apache.org.
+To host a JSettlers server that provides a web applet for clients, you will
+need an http server such as Apache's httpd, available from http://httpd.apache.org.
+The JSettlers-full.jar file can also run locally as a server, without
+needing a web server.  The applet is considered more convenient,
+because you know everyone will have the same version.
 
 To build JSettlers from source, you will need Apache Ant, available from
-http://ant.apache.org.
+http://ant.apache.org, or an IDE such as Eclipse which understands Ant's format.
 
 
 Setting up and testing
@@ -73,31 +73,30 @@ Setting up and testing
 
 From the command line, make sure you are in the JSettlers distribution
 directory which contains both JSettlers.jar, settlers-server.jar and the
-"lib" directory.  Start the server with the following command
-(server requires Java 1.4):
+"lib" directory.  (If you have downloaded jsettlers-1.1.xx-full.tar.gz,
+look in the src/target directory for these files.)
+
+Start the server with the following command
+(server requires Java 1.4 or higher):
 
   java -jar JSettlersServer.jar 8880 10 dbUser dbPass
 
-If MySQL is not installed and running (See "Database Setup"), you will
-see a warning with the appropriate explanation:
+If MySQL or another database is not installed and running (See "Database Setup"),
+you will see a warning with the appropriate explanation:
 
   Warning: failed to initialize database: ....
 
-The server will function normally except that user accounts cannot be
-maintained.
+The database is not required: Without it, the server will function normally except
+that user accounts cannot be maintained.  If you do use the database, you can give
+users a nickname and password to use when they log in and play.
+People without accounts can still connect, by leaving the password field blank,
+as long as they aren't using a nickname which has a password in the database.
 
 Now, from another command line window, start the player client with
 the following command:
 
   java -jar JSettlers.jar localhost 8880
 
-If you are using Java 1.1 you will need to unpack the Java archive
-(Java could not run directly from jar files until version 1.2). The
-commands to unpack, then start the client are:
-
-  jar -xf JSettlers.jar
-  java soc.client.SOCPlayerClient localhost 8880
-
 In the player client window, enter "debug" in the Nickname field and
 create a new game.
 
@@ -112,12 +111,13 @@ something like the following in the chat display:
   * > Games finished: 0
   * > Total Memory: 2031616
   * > Free Memory: 1524112
+  * > Version: 1100 (1.1.00) build JM20080808
 
 If you do not, you might not have entered your nickname correctly.  It
 must be "debug" in order to use the administrative commands.
 
 Now you can add some robot players.  Enter the following commands in
-separate command line windows:
+separate command line windows:  (See below for how to automate this.)
 
   java -cp JSettlersServer.jar soc.robot.SOCRobotClient localhost 8880 robot1 passwd
 
@@ -129,8 +129,9 @@ Now click on the "Sit Here" button and press "Start Game".  The robot
 players should automatically join the game and start playing.
 
 If you want other people to access your server, tell them your server
-IP address and port number (in this case 8880).  They will enter the
-following command (or use the instructions above for Java 1.1):
+IP address and port number (in this case 8880).  They can run the
+JSettlers.jar file by itself, and it will bring up a window to enter your IP
+and port number.  Or, they can enter the following command:
 
   java -jar JSettlers.jar <host> <port_number>
 
@@ -140,6 +141,14 @@ If you would like to maintain accounts for your JSettlers server,
 start the database prior to starting the JSettlers Server. See the
 directions in "Database Setup".
 
+If you would like robots to automatically start when your server starts,
+without the need for a separate command line, add the "startrobots" property
+to your jsettlers java command line, BEFORE the port number:
+
+    java -jar JSettlersServer.jar -Djsettlers.startrobots=3 8880 10 dbUser dbPass
+
+This will start 3 robots on the server.
+
 
 Shutting down the server
 ------------------------
@@ -151,16 +160,18 @@ disconnected.
 
 Hosting a JSettlers server
 --------------------------
-  - Start MySQL server (optional)
+  - Start MySQL or PostgreSQL server (optional)
   - Start JSettlers Server
   - Start http server (optional)
   - Copy JSettlers.jar jar and "web/*.html" server directory (optional)
-    - Extract JSettlers.jar to allow Java 1.1 clients (optional)
   - Copy "docs/users" to the server directory (optional)
 
-To host a JSettlers server, start the server as described in "Setup
+To host a JSettlers server, start the server as described in "Setting up
 and Testing". To maintain user accounts, be sure to start the database
-first. Remote users can simply start their clients as described there,
+first. (If you use a database, you can give users an account; everyone else
+can still log in and play, by leaving the password field blank.)
+
+Remote users can simply start their clients as described there,
 and specify your server as host.
 
 To provide a web page from which users can run the applet, you will
@@ -203,9 +214,29 @@ Database Setup
 --------------
 
 If you want to maintain user accounts, you will need to set up a MySQL
-database. This will eliminate the "Problem connecting to database"
+or PostgreSQL database. This will eliminate the "Problem connecting to database"
 errors from the server. We assume you have installed it correctly. 
 
+The default name for the database is "socdata".  To use another name,
+you'll need to specify it as a JDBC URL on the command line, such as:
+	-Djsettlers.db.url=jdbc:mysql://localhost/socdata
+or
+	-Djsettlers.db.url=jdbc:postgresql://localhost/socdata
+or
+	-Djsettlers.db.url=jdbc:sqlite:jsettlers.sqlite
+
+The default JDBC driver is com.mysql.jdbc.Driver.  PostgreSQL is also
+recognized.  To use PostgreSQL, use a postgresql url like the one shown above,
+or specify the driver on the SOCServer command line:
+	-Djsettlers.db.driver=org.postgresql.Driver
+
+Depending on your computer's setup, you may need to point JSettlers at the
+appropriate JDBC drivers, by placing them in your java classpath.
+Your database system's JDBC drivers can be downloaded at these locations:
+	MySQL:   http://www.mysql.com/products/connector/
+	PostgreSQL:  http://jdbc.postgresql.org/download.html
+	SQLite:  http://www.zentus.com/sqlitejdbc/
+
 Run the following commands to create the database and configure its
 tables.
 
@@ -217,7 +248,7 @@ CREATE TABLE users (nickname VARCHAR(20), host VARCHAR(50), password VARCHAR(20)
 
 CREATE TABLE logins (nickname VARCHAR(20), host VARCHAR(50), lastlogin DATE);
 
-CREATE TABLE games (gamename VARCHAR(20), player1 VARCHAR(20), player2 VARCHAR(20), player3 VARCHAR(20), player4 VARCHAR(20), score1 TINYINT, score2 TINYINT, score3 TINYINT, score4 TINYINT, starttime TIMESTAMP);
+CREATE TABLE games (gamename VARCHAR(20), player1 VARCHAR(20), player2 VARCHAR(20), player3 VARCHAR(20), player4 VARCHAR(20), score1 SMALLINT, score2 SMALLINT, score3 SMALLINT, score4 SMALLINT, starttime TIMESTAMP);
 
 CREATE TABLE robotparams (robotname VARCHAR(20), maxgamelength INT, maxeta INT, etabonusfactor FLOAT, adversarialfactor FLOAT, leaderadversarialfactor FLOAT, devcardmultiplier FLOAT, threatmultiplier FLOAT, strategytype INT, starttime TIMESTAMP, endtime TIMESTAMP, gameswon INT, gameslost INT, tradeFlag BOOL);
 
@@ -227,19 +258,23 @@ following command:
 
   java -jar JSettlers.jar soc.client.SOCAccountClient localhost 8880
 
+Users with accounts must type their password to log into the server to play.
+People without accounts can still connect, by leaving the password field blank,
+as long as they aren't using a nickname which has a password in the database.
+
 
 Development and Compiling
 -------------------------
 
-Source code for JSettlers is available via anonymous CVS. Source code
-tarballs are also made available.  See the project website at
-http://sourceforge.net/projects/jsettlers/ for details. Patches
-against CVS may be submitted there.
+Source code for JSettlers is available via tarballs and CVS.
+See the project website at http://nand.net/jsettlers/devel/
+or http://sourceforge.net/projects/jsettlers2/
+for details. Patches against the latest version may be submitted there.
 
 Before building, make sure you have at least version 1.4 of the Java
 development kit installed.  If you simply want to run the client and
-server, you only need the Java. If you wish to maintain a user
-database for your server, you need MySQL installed, and configured.
+server, you only need the Java Runtime (JRE). If you wish to maintain a user
+database for your server, you need MySQL or PostgreSQL installed, and configured.
 
 This package was designed to use the ANT tool available from
 http://ant.apache.org tools.  We assume you have installed it

data/data/settlers/jsettlers-1.1.09/VERSIONS.txt

@@ -0,0 +1,225 @@
+[ The list of the different public versions of JSettlers ]
+
+Unless otherwise indicated, versions are hosted at http://nand.net/jsettlers/devel/
+and (recent versions) at http://sourceforge.net/projects/jsettlers2/files/
+
+    > 1.1.09 (build 20100417)
+- 4-player board: crisper graphics (images from 6-player board)
+- Practice games don't expire (Rowan H idea)
+- Show rounds remaining for "roll no 7s during first n turns" (Rowan H idea)
+- When moving robber and choosing a victim, popup shows their # VPs
+- 6-player board: Always allow to request special build, even if no resources.
+     Also allowed at start of own turn, only if not rolled or played card yet,
+     and not when you are the first player taking your first turn.
+- 6-player: During Special Building Phase, a player can ask to Special Build after
+     the phase has begun, even if this means we temporarily go
+     backwards in turn order.  (Normal turn order resumes at the
+     end of the SBP.)  The board game does not allow this out-of-order building.
+- 6-player robots: Slow down a little: Pause 75% of 4-player's pause duration, not 50%
+- At end of game, hilight winner with yellow arrow
+- At end of game, show number of rounds, along with time elapsed and your resources rolled
+- Game options: Change of wording in minimum-version warning: ("friendly" format)
+	from: Client version 1107 or higher is required for these game options.
+	to :  Client version 1.1.07 or newer is required for these game options.
+- Double-clicking your face icon, or many rapid clicks, brings up the Face Chooser
+- Allow 3rd-party Robot AIs, via new rbclass param in IMAROBOT message, SOCClientData.isBuiltInRobot
+	Print robot type on connect (built-in, or rbclass name)
+- Fix: Ask 2nd practice game options, when 1st is over but its window still showing
+- Fix: robots: Handle CANCELBUILDREQUEST cleanly during states PLAY1 or SPECIAL_BUILDING
+- Fix: For game's 1st client, set game.clientVersionLowest (was always 0 before now)
+- 6-player window: Before expanding chat area when mouse enters it,
+	wait 200 ms (not 100 ms) in case mouse is just passing through.
+- Database: Hints on setup and usage of other db types in README.txt
+- Database: default jdbc driver changed to com.mysql.jdbc.Driver,
+	allow other db types via java properties (see README.txt)
+- Database: troubleshooting: print error message details when the driver is
+	available, but the database couldn't be accessed or loaded.
+- When running local server: Main panel: Show version, buildnum in tooltip
+- Command line: Error if dashed arguments appear after port/maxconns/db params
+- Command line: Allow -Djsettlers.option=value syntax (mchenryc)
+- Command line: Auto-start robots when the server starts, with this parameter:
+	-Djsettlers.startrobots=7
+- Debug assist: SOCBoardLayout2 prints array contents
+- Debug assist: Connection, LocalStringConnection +toString()
+- README.developer: Coding Style section
+
+    > 1.1.08 (build 20100112)
+- 6-player board, with Special Building Phase rule
+- Can now sometimes reconnect after connection to server is lost,
+     when message "A player with that nickname is already logged in" appears.
+- Smaller, cleaner building panel
+- Rotated-board mode, to make it easier to fit a larger board
+- Re-word counter offer text to: Give Them / You Get
+- Cleaner scaled graphics: Draw hex dice-number circles on hex, instead of GIFs.
+- Chat text prompt ("type here to chat") cleared when clicked (D Campbell idea)
+- Fix button redraw for Discard, Year of Plenty popups on OSX
+- Fix new-game options bg color on OSX Firefox 3.5+
+- BoardPanel faster redraw: cache image of board without pieces
+- BoardPanel javadocs explain nodeMap and initNodeMapAux
+- SOCRobotBrain refactor some message-handlers out of run() (C McNeil idea)
+- Old version history (pre-sourceforge): Added file src/docs/old-updates-rsthomas.html found on web at http://jrh-xp.byu.edu/settlers/updates.htm
+
+    > 1.1.07 (build 20091031)
+- Per-game options framework, including these options:
+	- PL  Maximum # players (2-4)
+	- RD  Robber can't return to the desert
+	- N7  Roll no 7s during first # rounds
+	- BC  Break up clumps of # or more same-type ports/hexes
+	- NT  No trading allowed
+- Re-word counter offer text
+- Hide trade offer after rejecting counteroffer (John F idea)
+- Allow debug commands in practice games
+- New applet parameter "nickname" for use with dynamic html (Rick Jones idea)
+- Framework for parsing "-" / "--" options at server commandline
+- Refactor per-turn resets from many places to new game.updateAtTurn()
+- GameList kept at server/client
+- Bugfix: Could sit down at 2 positions due to network lag
+- Rescaled board hex graphics now fall back to polygons if problem occurs
+- Removed unused hex graphics from soc/client/images (clay0-5.gif, misc0-5.gif, ore0-5, sheep0-5, wheat0-5, wood0-5)
+- Fewer disconnect-reconnect debug messages from robots during idle hours
+- Don't cover board with 'choose player' popup (Rowan H idea)
+- AskDialog supports multiple lines with "\n"
+
+    > 1.1.06 (build 2009-06-01)
+- Based on 1.1.04's code
+- Monopoly reports (privately) number of resources stolen to each victim
+- Reset practice game, at end of game: New randomly-selected robots, instead of same robots each time
+- STATUSMESSAGE can now carry an integer status value
+- Track and understand client version starting from connect time, not just from joingame time.
+- Can deny entry to individual games based on client's version (ex. client too old to understand a recent game feature, like 6 players)
+- Fewer debug messages from robots during idle hours
+- Many javadocs added
+- Bugfix: Hangs on mac osx 10.5 after a few minutes (SnippingTextArea)
+- Bugfix: After disconnect/rejoin, trade offer panel overlays your controls
+- Bugfix: "Start a local server" ignored port-number textfield, was always default port
+- Bugfix: harmless NullPointerException in SOCBoardPanel.setHoverText for getFontMetrics
+
+    > 1.1.05 (backed out)
+JSettlers 1.1.05 had been under development (build 2008-09-13) but its direction is being re-considered.
+Further development is based on 1.1.04.
+- Use Log4j 1.2, vs previous homegrown soc.debug/disableDebug
+
+    > 1.1.04 (build 2008-09-06)
+- Bugfix: Cancelling 2nd initial settlement, other players lost resources (SOCPlayer)
+- Bugfix: Don't disable "play card" button after buying or playing a card (SOCHandPanel)
+- Bugfix: Sometimes, "hovering" road or settlement wouldn't show during initial placement (SOCBoardPanel)
+- Give player's win/loss count at end of game, unless first game (new class SOCClientData)
+- Add StringConnection.appData, to support SOCClientData
+- Javadoc adds/updates
+
+    > 1.1.03 (build 2008-08-26)
+- Reset board: Bugfix: Practice games server version-check
+- Don't show hovering road/settlement/city unless player has the resources
+- "Play card" button: Disable after playing a card; Enable only at start of turn, not after buying a card
+- Bugfix: At end of game, client sometimes incorrectly showed player 0 (Blue) as winner
+- Javadocs clarify SOCPlayerClient local TCP vs practice server
+- Add minor items to TODO in README.developer
+
+    > 1.1.02 (build 2008-08-17)  http://nand.net/jsettlers/devel/
+- Reset board: If human leaves game before reset, lock their seat against robots
+- Bugfix: Robot disconnect/reconnect version reporting
+- Add minor items to TODO in README.developer
+
+    > 1.1.01 (build 2008-08-12)  http://nand.net/jsettlers/devel/
+
+- Bugfix: If player loses connection while voting for board reset, the vote never completes
+- Bugfix: Reset vote message format (from recent refactoring)
+- Version number dynamic from properties file, not hardcoded in soc.util.Version
+- Utility method SOCMessage.getClassNameShort for cleaner debug-output in template classes' toString
+
+    > 1.1.00 (build 2008-08-09)  http://nand.net/jsettlers/devel/
+
+- Development at new site, sourceforge project appeared abandoned in 2005
+- Much more visually responsive to game state
+- User-friendly
+	Can right-click on board to build, right-click ports or resource squares to trade  [sf patch 1905791]
+	Can right-click face to choose a new face [sf patch 1860920]
+	Popup dialog buttons wrap if window too narrow
+	Robber doesn't disappear when must be moved, it just "ghosts" [sf patch 1812912]
+	Other minor improvements
+- Local "practice-game" mode, if network connection or server is unavailable
+- Play with 2-4 players, no longer requires 4
+- Larger graphics on board, resizeable for higher-resolution screens [sf patch 1929452, based on images and code of rbrooks9's sf patch 1398331]
+- Ability to reset board, during or after game  [sf feature req. 1110481]
+- Can cancel and re-place initial settlement, if you haven't yet placed the road  [sf patch 1824441]
+- More robust handling if client's connection to server is lost, even if current player
+- Automatic dice roll after 5 seconds, if you have no playable card  [sf patch 1812254]
+- At end of game, show hidden VP cards for all players  [sf patch 1812497]
+- At end of game, give game duration and total connection time
+- Announce when longest road/largest army is stolen
+- Road-building allowed with 1 road [sf patch 1905080]
+- Can win only on your own turn; if not your turn, must wait
+- Less clutter in scrolling message area
+- Confirm quit before closing window
+- Show pieces when rejoining after lost connection
+- Attempt to end turn, if current player leaves the game
+- Client,server versioning; also add BUILDNUM property
+- Can double-click jar for local server hosting (or run w. no arguments); player GUI will ask for IP and port#
+- Robot bugfix, now will re-try if makes a bad piece placement
+- More advance warning when game will soon expire
+- Hilight who won when game is over
+- Reminder to place 2 roads with road-building card
+- Reminder to only play 1 card per turn
+- Reminder when VP cards are played
+- Trade offer's checkboxes track current player
+- New graphics: images/robot1.gif; Removed obsolete: images/arrowL.gif, arrowR.gif
+- Other sourceforge patches applied:
+	1816668 jdmonin AWT debug help
+	1816605 jdmonin Patch for #997263 cannot place road during game start
+	1816581 jdmonin Fix server treater startup race
+	1812257 jdmonin Debug help, minor comments
+	N/A     sfhonza (John Vicherek) "Swinging" number of resources, http://john.vicherek.com/jsettlers-1.0.6.swing_resources.patch
+	1088775 drichardson (Douglas Ryan Richardson) [1039250] Auto-rejecting impossible offers; Make accept button invisible when user cannot accept offer
+
+    > 1.0.6 (build 2004-11-17)  http://sourceforge.net/projects/jsettlers
+
+- Fixed the same PORT property error in the Account client
+- Fixed bug which could allow modified clients to invoke admin
+  commands (*STOP*, *KILLCHANNEL*, etc) (Lasse Vartiainen)
+- Fixed 920375, 1022157: mysql-connector-3.x fails: version 2.x works
+  (Mezryn)
+- Fixed 1060651: Bots crash if database backend is used (Jack Twilley)
+- Moved more SQL error handling and reconnecting from SOCServer to
+  SOCDBHelper correcting potential errors like 1060651
+
+    > 1.0.5 (build 2004-06-12)  http://sourceforge.net/projects/jsettlers
+
+- Fixed an error introduced into the applet initialization which kept
+  the PORT property from being read properly
+
+    > 1.0.4 (build 2004-06-10)  http://sourceforge.net/projects/jsettlers
+
+- build.xml file added for Ant builds
+- soc.util.Version class added so both build files and source code get
+  version and copyright info from build.xml. Clients and server updated
+- Build process creates two jar files: one for client, one for server
+- README updated for jar file invocation, with additional sections for
+  intro, requirements, hosting a server, and development
+- Fix for inconsistent game state when players leave a game.
+- Divider in chat window cannot be moved off-screen
+- Text of game chat now correctly scrolls to bottom of text.
+- Rewrite of much of the display code to address continuing display
+  issues. Methods which directly manipulate GUI components can cause
+  race conditions, and are now never called from main networking
+  thread.
+- Removed calls to deprecated methods
+- Images can now be loaded from files (on server or not) or from
+  within jar.
+
+    > 1.0.3 (build 2004-03-29)
+
+- Continuing to fix the display bug in the SOCPlayerClient
+
+    > 1.0.2 (build 2004-03-26)
+
+- Fixed display bug (again) in the SOCPlayerClient when run as a stand
+  alone.
+
+    > 1.0 (build 2004-03-14)
+
+- First release. See the README file for how to setup a server and
+  robot clients.
+
+    > For older version information:
+
+- see src/docs/old-updates-rsthomas.html for 5/3/00 through 03/15/04.