Skip to content
This repository

Mobile robot simulator

tree: 9193b68376

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 demo
Octocat-spinner-32 doc
Octocat-spinner-32 include
Octocat-spinner-32 src
Octocat-spinner-32 tests
Octocat-spinner-32 tools
Octocat-spinner-32 worlds
Octocat-spinner-32 AUTHORS
Octocat-spinner-32 COPYING
Octocat-spinner-32 ChangeLog
Octocat-spinner-32 INSTALL
Octocat-spinner-32 Makefile
Octocat-spinner-32 Makefile.am
Octocat-spinner-32 Makefile.common
Octocat-spinner-32 NEWS
Octocat-spinner-32 README
Octocat-spinner-32 bootstrap
Octocat-spinner-32 configure.in
README
****************************************************************************
* README.stage  - Richard Vaughan - Stage-1.2       
*                                                                          
* $Id: README,v 1.1 2002-06-11 06:48:15 rtv Exp $    
****************************************************************************

This README provides a quick-start guide to building and running
Stage.  Consult the Stage User Manual for full details.

-- What is Stage? ---------------------------------------------------------

Stage simulates mobile robots and sensors in a two-dimensional
bitmapped environment containing a variety of objects. Robots are
controlled through Player. Player provides a powerful, flexible
interface to ActivMedia Pioneer 2; Stage provides virtual devices for
Player. Various sensor models are provided, including sonar, scanning
laser rangefinder, color blob tracking from a pan-tilt-zoom camera and
odometry. Several controllers designed in Stage have been demonstrated
to work on real robots.

It was designed at the USC Robotics Research Labs to support research
into multi-agent intelligent autonomous systems.

-- How to get Stage -----------------------------------------------------

The primary source for Player and Stage is:

http://playerstage.sourceforge.net

-- Ownership ------------------------------------------------------------

Stage is released under the GNU General Public License.

Stage programs, images, examples, source code and documentation are
copyright (c) the authors.

These fine people worked on Stage:

Richard Vaughan
Andrew Howard
Brian Gerkey
Kasper Stoy
Boyoon Jung
Jakob Fredslund

Stage's development is supported at the University of Southern
California by DARPA's TMR & MARS programs, and by an NSF grant.
Richard Vaughan now works for HRL Laboratories, Malibu, CA.

-- Whats here? ------------------------------------------------------------

stage    - the simulation engine.
       
Some example environments and setup files are provided, along with a
manual and this bootstrap documentation

-- Requirements ------------------------------------------------------------ 

Developed and tested under Linux kernel 2.4.2, glibc-2.2.4.  Written
in reasonable ANSII/POSIX so should compile elsewhere. No promises,
but people have found it to work on a variety of set-ups.

Requires: Player [http://playerstage.sourceforge.net], X11R6, GTK.

-- Compiling ---------------------------------------------------------------

0) Obtain and install Player (http://robotics.usc.edu/player)

1) unpack the Stage tarball with

$ tar xzvf Stage-<version>.tgz

2) Check the top-level makefile (stage/Makefile.common). You must set
the path to your Player source directory. Other settings, such as
installation directory and the location of X11's color database can
also be made here. If you have trouble compiling, you should first
check these settings.

3) compile stage:

$ cd stage
$ make 

will make the executable src/stage.

Optionally, as you can do:
 
$ make install

this will install the executables in $HOME/Stage-<version>/bin/stage
(unless you otherwise configured the installation target in
Makefile.common)

-- Running ---------------------------------------------------------------

To run stage, first make sure the Player executable can be found in
your path.

To run stage itself do:

$ stage [options] <filename.world>

The .world file specifies what stage must simulate. The command-line
options are described in the manual, and can be listed by doing:

$ stage -?

To try out Stage with an example world, change to the installation
directory and do:

$ bin/stage examples/simple.world 

-- Configuration file ----------------------------------------------------

The user defines a world to simulate in Stage's configuration
(*.world) file. The world file format is documented in the manual, but
you can get the idea from looking at the examples.

--------------------------------------------------------------------------

Enjoy, and let us know what you do with Stage.

 -- The Player/Stage team.





Something went wrong with that request. Please try again.