Updating README.md

This commit is contained in:
Raydelto Hernandez 2020-06-06 17:36:24 -03:00
parent 3c4f0b7b1d
commit 1ff22bfbf2

View file

@ -1,14 +1,8 @@
# Polly-B-Gone # Polly-B-Gone
**Polly-B-Gone** is a 3D physics platform game that tells the story of a plucky wheeled robot named Polly, who has been imprisoned by the nefarious Dr. Nurbs in his laboratory. Polly must overcome a series of increasingly-elaborate obstacles to escape and regain her freedom. Polly was my entry in the 2008 [CS 248](http://graphics.stanford.edu/courses/cs248-08/) video game competition, and she won the grand prize! **Polly-B-Gone** is a 3D physics platform game that tells the story of a plucky wheeled robot named Polly, who has been imprisoned by the nefarious Dr. Nurbs in his laboratory. Polly must overcome a series of increasingly-elaborate obstacles to escape and regain her freedom. Polly was Mike Bostock's entry in the 2008 [CS 248](http://graphics.stanford.edu/courses/cs248-08/) video game competition, and it won the grand prize!
## Download [You can find more information about this project on its Stanford official page.](http://cs.stanford.edu/people/mbostock/polly)
Polly-B-Gone is currently available as a binary only for Mac OS X:
* [polly-1.0.dmg.zip](http://cs.stanford.edu/people/mbostock/polly/polly-1.0.dmg.zip)
It has only been tested on 10.5 (Leopard), but it probably works on other versions. For other platforms, youll need to build from source and make modifications as necessary.
## Screenshots ## Screenshots
@ -19,9 +13,17 @@ It has only been tested on 10.5 (Leopard), but it probably works on other versio
<img src="http://cs.stanford.edu/people/mbostock/polly/airborne.jpg" width="640" height="400" border="2"> <img src="http://cs.stanford.edu/people/mbostock/polly/airborne.jpg" width="640" height="400" border="2">
<img src="http://cs.stanford.edu/people/mbostock/polly/a-balancing-act.jpg" width="640" height="400" border="2"> <img src="http://cs.stanford.edu/people/mbostock/polly/a-balancing-act.jpg" width="640" height="400" border="2">
## Controls
* You can move Polly, using the W,A,S,D keys.
* SPACE pauses the game
* F9 Toggles on/off worls textres
* F10 Render helper vectors
* F11 toggles the Full Screen mode.
## Documentation ## Documentation
The entire game world for Polly-B-Gone is specified as an XML file. You can edit world.xml to create new levels, new puzzles, and even change the music, textures and lighting! See the [wiki](/mbostock/polly-b-gone/wiki) for details. The entire game world for Polly-B-Gone is specified as an XML file. You can edit world.xml to create new levels, new puzzles, and even change the music, textures and lighting! See the [wiki](http://cs.stanford.edu/people/mbostock/polly) for details.
## Third-Party Libraries ## Third-Party Libraries
@ -30,3 +32,33 @@ Polly-B-Gone uses the [Simple DirectMedia Layer](http://www.libsdl.org/) Library
## Third-Party Content ## Third-Party Content
[Texturama](http://texturama.com/) provided the textures for the ceramic, concrete, and drain materials. These images are copyright XY3D, Texturama, and Eric Brian Smith and may not be redistributed for any other purpose without the permission of the copyright holders. The clover and ivy textures are from the [Blender for Architecture](http://blender-archi.tuxfamily.org/) website and are distributed via the Creative Commons Attribution License version 2.5. The MIDI files for the background music come from the "Very Best of GUS MIDI" collection, which is available from the SDL_mixer website (see above). According to the compilation author, "all of these MIDI files are freely distributable, but most of them are copyrighted." [Texturama](http://texturama.com/) provided the textures for the ceramic, concrete, and drain materials. These images are copyright XY3D, Texturama, and Eric Brian Smith and may not be redistributed for any other purpose without the permission of the copyright holders. The clover and ivy textures are from the [Blender for Architecture](http://blender-archi.tuxfamily.org/) website and are distributed via the Creative Commons Attribution License version 2.5. The MIDI files for the background music come from the "Very Best of GUS MIDI" collection, which is available from the SDL_mixer website (see above). According to the compilation author, "all of these MIDI files are freely distributable, but most of them are copyrighted."
## Building on GNU/Linux
The GNU/Linux Makefile was created by Raydelto Hernandez (raydelto [at] gmail.com). It was tested un Ubuntu 20.04 on June 2020.
If you want to build this code on GNU/Linux you first need to install the following libraries:
* OpenGL
* GLEW
* GLU
* GLUT
* TinyXML
* SDL
* SDL Mixer
* SDL Image
If you are using Ubuntu you can install these libraries by typing the following command:
```
sudo apt-get install build-essential libgl1-mesa-dev libglu1-mesa-dev libglew-dev freeglut3-dev libsdl1.2-dev libsdl-mixer1.2-dev libsdl-image1.2-dev libtinyxml-dev
```
Then , finally , build the code by running the following command
```
make
```
Finally, you can run the freshly built game running:
```
./bin/main
```