Jim E. Brooks
http://www.palomino3d.org
2006/11/24

License and copyright:
----------------------

This software (source code and binaries) is released under
the terms of the GNU General Public License (GPL).
Source code is Copyright (C) 2006,2004 Jim E. Brooks
except where noted otherwise.
See LICENSE_GNU_GPL.txt or http://www.gnu.org/licenses/gpl.txt

Palomino's source code was integrated with other source code
also licensed under the GPL.
The other source code is Copyright (C) by the original authors.
- GL-117 (Targa file and font code)
  license: GPL, http://www.heptargon.de/gl-117/gl-117.html
- libnoise (Perlin noise code)
  license: GPL, http://libnoise.sourceforge.net

Synopsis:
---------

Palomino is an arcade-style simulator of a P-51D Mustang that I
originally implemented in the late '80s using my own graphics system.
Palomino has since been further developed and ported to modern
hardware-accelerated OpenGL systems.  The design goals are fast
rendering and to be easy-to-fly.  A joystick is supported on Linux
(/dev/input/js0).

Quick-start:
------------

To start flying (keyboard):
  Press F3, F12, 1, Cursor Down (pitch up).

To start flying (joystick):
  Cmd-line: pass -j (-jd 1 1 -1 to reverse throttle orientation)
  Joystick throttle down, press F3, F12, 1, throttle up, pitch up.

Press Backspace to restart after crashing.

See manual.html.

Software requirements:
----------------------

- OpenGL, GLUT
- GNU C++ compiler (2.9 or later)
- GNU tools
- zlib
  If unavailable, do "gunzip *.tga.gz" in the texture dirs,
  then compile using "make GFX_ZLIB=0".

Compiling (GNU/Linux/FreeBSD):
------------------------------

The source should compile on a UNIX system with GNU tools
(Linux and FreeBSD for sure).
If not, ensure you're using GNU make (gmake on FreeBSD),
and that the Mesa and X11 development packages are installed.
To speed compiling, parallel make -j can be used and also
the network-distributed compiler distcc: make -j8 CC=distcc

Which compiler can be specified by the CC= arg to make.  For example,
if the gcc 4.0.0 RPM is installed on Fedora Core 3, for faster code:
make CC=g++4

Compiling (Apple Mac OS X):
---------------------------

Requires:
- Xcode developer tools and X11 (supplied on the Mac OS X installation discs).
- May also require Fink which is a port GNU tools: http://fink.sourceforge.net

Compiling (Windows):
--------------------

Requires:
- cygwin which is a port of GNU tools: http://www.cygwin.com

Documentation:
--------------

See manual.html

Problems:
---------

- Joystick:

  Linux: If program doesn't detect joystick, try modprobe joydev
  Mac:   Joystick not supported yet.

- Control response:

  Changes to control response using the GUI will be saved (~/.palomino.cfg)
  but using Shift-[0..9] are temporary.

- If clouds ripple (known to happen on older ATI Radeons):
  Press Shift-P to change perspective.
  Then if chase-plane disappears, press +/- to adjust its distance.

- If compiling fails because the build system isn't detecting
  your platform properly, try:

  make ARCH=generic

- If color doesn't look right:
  Try reducing fog by passing -fog-density n where n is a floating-point number
  typically between 0.0 and 1.0 (higher values are possible):
  sim -fog-density 0.5

- If textures look bad or cause slowness on your system, pass -no-textures

- On FreeBSD 4.x, if OpenGL/Mesa doesn't work (shows a blank window),
  try adding these lines to /boot/loader.conf (be careful):

      agp_load="YES"
      linux_load="YES"

  And loading dri/glx by /etc/X11/XF86Config-4

      Section "Module"
          Load  "dri"
          Load  "glx"
       EndSection

To package this program:
------------------------

[2006/11] Instructions to help make a UNIX package (RPM, FreeBSD port):

Program will try to find its supporting files at:
/usr/share/games/palomino

# Copy textures (tga.gz), 3D models (.pal), and Python files:

mkdir -p /usr/share/games/palomino
chmod a+rx /usr/share/games/palomino
cp ~/palomino/palomino/modules/pony/textures/*.tga.gz  /usr/share/games/palomino
cp ~/palomino/palomino/modules/pony/models/*.pal       /usr/share/games/palomino
cp ~/palomino/palomino/engine/src/*.py                 /usr/share/games/palomino
cp ~/palomino/palomino/modules/pony/src/*.py           /usr/share/games/palomino
chmod a+r /usr/share/games/palomino/*

------
Enjoy!
