jknoetzke / goldenserver Goto Github PK

GoldenServer -- race and train via GoldenCheetah over "the Internets"

Contributors:
   Justin Knotzke    [jknotzke {at} shampoo.ca]
   Steve Gribble     [gribble {at} cs.washington.edu]
   Mark Liversedge   [liversedge {at} gmail.com]


Welcome to GoldenServer!


LICENSE

This project is covered by the GNU General Public License, version 2.
Please see COPYING for the terms of this license.

Distributed with this project is Apache's log4j .jar file
(lib/log4j-1.2.15.jar).  log4j is covered by the Apache License
version 2.0 (lib/log4j-1.2.15.license.txt).


COMPILING AND RUNNING

This project is Java-based and is compiled/run using ant. If you
haven't installed ant yet, please do so now.

To compile the server, run:

  ant clean-build

To compile and execute the server, run:

  ant

To clean dynamically generated files, run:

  ant clean

We strongly suggest running "ant clean" before doing any
git-related stuff, so that you don't accidentally check in
any non-source files.


CUSTOMIZING THE LISTEN PORT AND GOLDENWEB URL

GoldenServer listens for incoming client connections on a
TCP port.  By default, this port is 9133.  If you'd like
to use a different port, run ant with the optional
"-Dport=xxxx" argument.

GoldenServer polls a Web page to learn about newly defined
races.  By default, the URL it polls is:

  http://www.cs.washington.edu/homes/gribble/tmp/gs.txt

To use a different URL, run ant with the optional
"-Dgweb_url=xxxxxx" argument.

For example, you could run ant with:

  ant -Dport=6666 -Dgweb_url="http://foo.com/bz.txt"


PROTOCOL DOCUMENTATION

You can file documentation for the GoldenServer/GoldenCheetah
protocol in doc/protocol_spec.txt.

Java marshaling/unmarshaling code is in:
    src/org/goldencheetah/goldenserver/ProtocolHandler.java

C++ marshaling/unmarshaling code is in the GoldenCheetah distribution,
in the src/ProtocolHandler.cpp and src/ProtocolHandler.h.


ROBOT RIDER

For testing purposes (or to impress your friends!) we have included
RobotRider, a softbot that connects to a GoldenServer and sends
synthetic telemetry information.

To run RobotRider, give the following command (substituting in the
correct raceid, GoldenServer hostname, and GoldenServer port):

  ant robot -Draceid="519ca13cda46441a01211cffb491cf3a" \
   -Dhostname=foo.bar.com -Dport=9133