jquake/server/readme.txt

   1 1. Installation of the JQuake Server
   2 ------------------------------------------------------------------------------
   3
   4 The JQuake Server is a Java application that handles
   5 a number of JQuake clients. This will allow a simple
   6 deatchmatch.
   7
   8 The JQuake Server must be run on the http server on
   9 which the JQuake applet is stored. It can either be
  10 started with a java application viewer, like "jview",
  11 or on NT-machines, as a service.
  12
  13 The JQuakeServer.zip should be unzipped recursively
  14 in a subdirectory, e.g. "JQuakeServer".
  15
  16 1.1 Starting it as an application
  17 ---------------------------------
  18
  19 When running it with "jview", enter the subdirectory
  20 JQuakeServer and start it with:
  21
  22 jview JQuakeServer [ option1="value1" [ option2="value2" [ ... ] ] ]
  23
  24 where the options are:
  25
  26 port:                ServerPort. Default: 27100
  27 moveRate:            Frequency at which actors are moved. Default: 60.
  28                       High is good, but if it takes too much CPU-time, it
  29                       can be lowered.
  30 minMovesPerSend:     Minimum number of moves per send - i.e. max packet
  31                       transmission frequency will be moveRate / movesPerSend.
  32                       The clients will automatically request about as much
  33                       much as they can handle, so this value will only affect
  34                       clients with very fast computers and good connections.
  35                       Default: 1
  36 map:                 The map that will be played. Default: binaries/dm4.bin
  37 maxClients:          Maximum number of clients that can connect. Default: 6.
  38                       The fraglist in the chat-applet will not look nice if
  39                       you enter a higher value than 6. We'll see if we can
  40                       autoresize the chat-applet after maxClients.
  41 welcomePhrase:       The phrase that greets a newly connected player.
  42                       Default: null
  43 msgLevel:            A higher value prints more messages. Default: 0
  44                                          -1: No messages
  45                       0: Only prints "initializing" and "initialized"
  46                       1: Prints connection requests and stuff
  47                       2: Prints even more.
  48                       3: Prints a lot.
  49                       More than 1 is not recommended except for testing purposes.
  50                       More than 0 is not recommended for services on NTs.
  51
  52 example:
  53 jview JQuakeServer port="27100" welcomePhrase="Welcome to Our Server"
  54
  55 Make sure that the server is run using a JIT-compiler. Sometimes you need
  56 to pass an option to "jview", like "-jit".
  57
  58 1.2 Starting it as a NT service
  59 -------------------------------
  60
  61 Starting it as a NT service is a bit more complicated.
  62 We'll add the description soon.
  63
  64
  65 2. Setting up the JQuake Applet.
  66 ------------------------------------------------------------------------------
  67
  68 Hopefully you have received or snatched a HTML page with the JQuake Applet.
  69 Parameters are given with the same syntax as the server when running
  70 as a standalone application. When running as an applet it's just applet
  71 parameters.
  72 One applet parameter that is always required is the "CABBASE", which should
  73 be "JQuakeNChat.cab". Other parameters are:
  74
  75 mipmapLevel:        1 if all textures should be resampled with a lower
  76                      resolution, to save memory. Default: 1
  77 zoom:               1 if scene should be rendered at 160*100 and stretched
  78                      to 320x200. A bit obsolete, since you can chose with
  79                      '+' and '-'. Default: 0
  80 sleep:              The client will sleep( sleep ) between each frame, if
  81                      sleep > 0. Default: 0. The framerate will, of course,
  82                      drop if you sleep, so it's not recommended.
  83 map:                Map to be played. Default: "binaries/dm4.bin". Must be
  84                      same as map-parameter the server was started with.
  85 deathmatch:         1 if you're running a server that the client should
  86                      connect to. Default: 0
  87 serverAddress:      IP-address of the server. Default: getCodeBase - i.e.
  88                      The address of the server on which the applet is stored,
  89                      so normally this parameter is not needed, since the server
  90                      must be run there. Mainly used for debugging purposes or
  91                      when running it as a standalone application.
  92 serverPort:         Port on which the server is listening. Default: 27100.
  93                      Must be same as the port-parameter the server was started
  94                      with.
  95 maxClients:         Maximum number of clients that can connect to the server.
  96                      Important: must be same as on server! Default: 6
  97 failsafe:           1 turns off networking and displays images with a slightly
  98                      more "reliable" technique. Default: 0. Not needed for any
  99                      browser, as far as I know.
 100 gif:                1 makes JQuake load GIF-images instead of JPG-images.
 101                      GIFs are larger and are not included in the .CAB-file,
 102                      so it will take much longer to load, but some VMs can't
 103                      load JPGs.
 104
 105 3. Additional info.
 106 ------------------------------------------------------------------------------
 107
 108 We need information about the server you set up so that we can include a
 109 reference to your JQuake applet from our pages. We will put an additional link
 110 to any page you request.
 111
 112 When you add the JQuake applet to any of your pages, add a link to the JQuake
 113 homepage at "http://hem1.passagen.se/carebear/JQuake.htm" and an optional mail
 114 link to "scitech@thermometric.se".
 115
 116 DO NOT redistribute the JQuakeServer and JQuakeClient classes. In this way we
 117 hope not to take undue advantage of ID Software's kindness to use their
 118 copyrighted material.
 119
 120 You can instead mail us at "scitech@thermometric.se" and ask for copies of
 121 JQuakeServer and JQuakeClient.
 122
 123
 124