home *** CD-ROM | disk | FTP | other *** search
/ The Net: Ultimate Internet Guide / WWLCD1.ISO / pc / java / enxle1f6 / readme < prev    next >
Encoding:
Text File  |  1996-08-14  |  7.4 KB  |  164 lines
  1. Europa README
  2. -------------
  3.  
  4. Contents
  5.  
  6. 0. Overview
  7. 1. Running the Server
  8. 2. Running the Client
  9. 3. Compiling the Source
  10. 4. Tested Platforms
  11. 5. Running without Symbolic Links
  12. 6. More Documentation
  13. 7. Feedback
  14.  
  15. -----------------------------------------------------------------------
  16.  
  17. 0. Overview
  18.  
  19. This file contains directions for setting up and running Europa. Europa
  20. is a multi-player client-server game, so the instructions for running
  21. the server must be carried out first. These instructions are followed
  22. by technical details on how to compile the game if desired (it comes
  23. precompiled in the distribution) and a list of platforms that the game
  24. has been tested on. At the very end of this document are some special
  25. notes for those installing on a WindowsNT server or a Windows95
  26. computer, that explain how to set up the game without using symbolic
  27. links that are in the distribution tar file.
  28.  
  29. The instructions assume the existence of a Korn Shell and some other
  30. standard UNIX-style tools. We used the MKS toolkit to test under
  31. Windows, and recommend it. If you don't have such tools you will have
  32. to read and understand the scripts to carry out what they do by hand.
  33. We have also assumed the existence of correctly installed TCP/IP network
  34. support.
  35.  
  36. We compiled and tested using the Java Development Kit v1.0. We've made
  37. an effort to test on a variety of platforms, but the main platform used
  38. for testing was SunOS 5.4.
  39.  
  40. Directories:
  41.  
  42. README    - this file
  43. bin        - handy scripts for running the client & server
  44. classes - actual .class files
  45. html    - WWW pages for the game, with rules & applet
  46. server    - directory to run the server, with images/sounds/player file/logs
  47. src        - source tree for the distribution
  48.  
  49.  
  50. 1. Running the Server
  51.  
  52. The server must be started before the game can be played. You need to
  53. have java set up so that you can run applications using the java
  54. interpreter directly, and have Korn Shell installed in /bin/ksh for
  55. things to work without modification. On Windows 95, or Windows NT, we
  56. tested the distribution using the MKS Toolkit Korn Shell. The scripts
  57. for PCs have .ksh extensions and the UNIX scripts have no extension.
  58.  
  59. Test your java installation by running a java applet out of the demo
  60. directory. For example, cd to java/demo/ArcTest and issue the command
  61. java ArcTest. If the ArcTest applet comes up the scripts for running
  62. the client and server should work without modification.
  63.  
  64. To load the server, cd to the Europa/bin directory, and execute the
  65. startserver script. This will start the server, and the server log
  66. file will be placed in Europa/server/log. You can tail -f log to
  67. watch the log messages as they are entered into the server; a typical
  68. correct startup will look like:
  69.  
  70. Wed Mar 27 04:32:41 EST 1996: log service started
  71. Wed Mar 27 04:32:41 EST 1996: finished reading player file
  72. Wed Mar 27 04:32:41 EST 1996: Starting server on port #5000
  73. Wed Mar 27 04:32:41 EST 1996: Max players = 128
  74.  
  75. After 10 minutes the player file will be auto-saved, which will be the
  76. next log message if nobody logs in in that time. This script is simple
  77. and extensively tested. If you have a problem, make sure you can run
  78. ArcTest, and make sure you are running the script in Europa/bin.
  79.  
  80. Once the server is running, you are ready to load the client.
  81.  
  82. 2. Running the Client
  83.  
  84. To begin with, test that everything is working by running the client on
  85. the same machine as the server. This can be done by running the europa
  86. script in the Europa/bin directory. It will start an applet viewer, and
  87. a login dialog. You can click "I'm new" to create a new player and the
  88. game selection screen will appear. From this screen just choose "Quit"
  89. to quit - the client is working and it is time to set it up from the
  90. web pages. Alternately, you can log in with the built in admin account,
  91. named admin, password admin. Naturally you should change this password
  92. using the "Change Info" button after you have logged on.
  93.  
  94. Create a symbolic link from your web pages to the Europa/html/Europa
  95. directory.  This will allow people to view the Europa pages to read the
  96. rules and play the game. Do not create a symbolic link to any directory
  97. above the Europa/server directory because the player file, complete
  98. with non-encrypted passwords, could be compromised if you do that
  99. (encryption is forbidden for contest entries; we'll add typical UNIX
  100. crypt encryption for a later release). Once the symlink is made you can
  101. load the pages into your java-capable WWW browser. Alternatively, you
  102. can use the browser's file..open menu (if it has it) to open the html
  103. files directly.
  104.  
  105. Take a moment to browse the pages to be familiar with the game since it
  106. is quite complex and not necessarily intuitive if you do not know the
  107. controls. Then take the plunge, and load the log-in and play. Because the
  108. game runs in separate windows, you can always keep the controls instructions
  109. up while playing to refresh your memory at first.
  110.  
  111.  
  112. 3. Compiling the Source
  113.  
  114. To rebuild the entire source hierarchy, cd Europa/src and run ./buildall
  115. which will recompile the entire client and server. If you have tested
  116. running the script to start the server then the buildall script should
  117. run without modification. The source should build without any errors.
  118.  
  119. To compile an individual directory or file, use the -d option to the
  120. javac compiler to ensure that the .class files are placed in the
  121. Europa/classes directory. Also when compiling you need to ensure that
  122. the Europa/classes directory is in the CLASSPATH; this is done 
  123. automatically by buildall but must be done by hand to compile an
  124. individual directory or file.
  125.  
  126. 4. Tested Platforms
  127.  
  128. We have made an effort to test the client and server under a variety of
  129. platforms. The server has been run on SunOS 5.5, Windows 95, and Windows
  130. NT 3.51. The client works on SunOS 5.5, IRIX 5.4, Linux (version unknown),
  131. Windows NT 3.51, and Windows 95. The game is designed to work well with
  132. even slow network connections; it is built around the assumption of that
  133. players will connect via PPP or SLIP over a slow modem link. We have tested
  134. under these conditions at length, perhaps because we're addicted.
  135.  
  136. 5. Running without Symbolic Links
  137.  
  138. Under Windows NT and Windows 95 you will need to copy the classes/games
  139. directory and the classes/win directory to the html/Europa/client
  140. directory. Under UNIX it is more efficient to leave the existing symbolic
  141. links. If you actually plan to modify any part of the client under NT,
  142. it is best to eliminate one of the classes directories and only use
  143. the other one to avoid confusion as to what classes are being loaded.
  144.  
  145. Also, in the Europa/html/Europa directory, copy Europa.html to index.html.
  146.  
  147. 6. More Documentation
  148.  
  149. All of the classes have been prepared for processing by javadoc, the java
  150. utility for producing documentation from .java files. The resulting documents
  151. are in Europa/docs and provide a convenient reference to the classes. In
  152. addition, there is a small amount of casual documentation, which documents
  153. the thinking and development process behind the game, in Europa/html/casual.
  154. These pages aren't linked in off of the main WWW pages in Europa/html/Europa
  155. because they aren't intended for end user consumption.
  156.  
  157. 7. Feedback
  158.  
  159. The authors proud of this product and would welcome feedback that you may
  160. have, both positive and negative. You can reach us for help, to request new
  161. features, or just to say you like it/hate it, via our e-mail addresses. The
  162. addresses are on our home pages, which are referred to right off of the 
  163. Europa pages. We hope you enjoy the game! 
  164.