next up previous contents
Next: 0.2 A Note on Up: 0. Metadata Previous: 0. Metadata   Contents

0.1 How to Read this Manual

We know that you are dying to read this entire document, but let us give you some advice that may save you some time. If you are only planning to use Player with the Stage simulator, then you should only need to read Chapters 1 and 3 and the manual appropriate to the language in which you will write your programs. For example, if you plan to use the C++ client utilities, then read Player C++ Client Library Reference Manual. The manual that you are currently reading only includes documentation for the C reference client. Language-specific manuals are provided with the distribution (and are available from the homepage) for C++, Tcl, and LISP. Client libraries have also been contributed by users for other languages, including Python, Java, and Visual C++. These other client libraries are distributed separately; see the contributed clients page for details:
http://playerstage.sourceforge.net/clients/clients.html
If you intend to use Player with physical hardware, then you should also read Chapters 2 & 4 and consult Chapter 7 in order to familiarize yourself with the details of connecting the hardware and telling Player where it is. If you are interested in modifying an existing client library or writing your own, then you should also read Chapters 5 & 6, which describe the message protocol and data formats between client and server. Finally, if you want to hack on the server in any way (e.g., add a new device driver, write your own Player server for a different language/platform), then you should also read Chapter 8, which will (hopefully) provide all the information that you will need.


next up previous contents
Next: 0.2 A Note on Up: 0. Metadata Previous: 0. Metadata   Contents
2004-06-02