Pioneers

Pioneers is an Internet playable implementation of the Settlers of
Catan board game.  The aim is to remain as faithful to the board game
as is possible.

Playing the Game
================

Pioneers is a multi-player game.  Each player must run the Pioneers
client: pioneers.  One of the players must also run the Pioneers
server: pioneers-server-gtk or pioneers-server-console.

The GTK server has a user interface in which you can customise the
game parameters.  Once you are happy with the game parameters, press
the Start Server button, and the server will start listening for
client connections.

When you start the client program, it displays a connect dialog.  You
must define the hostname and port where the server can be located.
You can enter these manually, or press the Meta Server button.  The
meta server maintains a list of all registered Pioneers servers that
are currently running a game.  This allows you to join a game anywhere
on the Internet.

Pioneers is most fun with three or four players, but two players is
still ok, or you can add some computer players if you like.

Simple install procedure
========================

  % tar xvzf pioneers-<version>.tar.gz	# unpack the sources
  % cd pioneers				# change to the toplevel directory
  % ./configure				# regenerate configure and run it
  % make				# build Pioneers
  [ Become root if necessary ]
  % make install			# install Pioneers

Building RPM Binary Packages
============================
This section is intended to make it easier for those people that wish to
build RPMs from the source included in this package, but aren't sure how.

1) Copy pioneers-<version>.tar.gz to your RPM SOURCES directory. Usually
   this is /usr/src/packages/SOURCES

2) In your RPM SOURCES directory, issue the command
   'rpmbuild -ta pioneers.spec'.
   This will cause rpm to extract the pioneers sources to a temporary
   directory, build them, and build rpm packages based on the information in
   the spec file. The binary rpms will be put into your RPM RPMS directory.
   Usually this is /usr/src/packages/RPMS/<platform>/.

If you have any further questions, please refer to the RPM documentation.

Building Debian Binary Packages
===============================
This section is intended to make it easier for those people that wish to
build Debian binary packages (.deb's) from the source included in this
package, but aren't sure how.

1) Extract pioneers-<version>.tar.gz inside a temporary directory. The
   Debian binaries will be placed in this directory. A directory named
   pioneers-<version> will be created when you extract the archive.

2) Change into the pioneers-<version> directory.

3) Issue the command dpkg-buildpackage (You must have dpkg-dev installed in
   order to issue this command). This will configure and build the Debian
   binaries, placing them in the parent directory of your current directory.

If you have any further questions, please refer to the Debian dpkg
documentation.

Short guide to install Pioneers in Cygwin

Install Cygwin
==============
1) Get 'setup.exe' from the Cygwin site (www.cygwin.com)
2) Select (additional packages will automatically be selected):
	gcc4
	gettext-devel
	gnome-common
	gvim
	intltool
	libgtk2.0-devel
	libtool
	make
	netpbm
	patch
	patchutils
	rsvg
	subversion
	twm
	xinit
	gdk-pixbuf2.0-svg

3) Download and install gob2 (at least 2.0.18)
   http://ftp.5z.com/pub/gob

   (./configure --prefix=/usr; make all install)

You now have the setup needed to build and run Pioneers.

Build Pioneers from the repository
==================================
If you only want to use released versions, skip to the 'Install Pioneers'
section.

1) Get the code from the Subversion repository
   svn checkout svn://svn.code.sf.net/p/pio/code/trunk/pioneers pioneers
2) Go to the pioneers directory
3) Run automake, build and install
     ./autogen.sh
     make
     make install

Install Pioneers
================
1) Download the source tarball to your Cygwin home directory
   (c:\cygwin\home\%username%)
2) Start the Cygwin shell
3) Expand the source tarball
   (tar xvzf pioneers-%versionnumber%.tar.gz)
4) Enter the source directory (cd pioneers-%versionnumber%)
5) Configure, build and install
     ./configure
     make
     make install

Play Pioneers
=============
6) Start the X server (startx)
7) Start Pioneers from the XTerm (pioneers)

Known limitations
=================
* The help is not built
* The metaserver does not work (not ported to MS Windows)

Roland Clobus
2013-06-17 (Pioneers 15.1)

Instructions for building Pioneers in the MinGW environment are in the MinGW
directory.