Installing and running Pyskool
==============================

General notes
-------------
Pyskool requires `Python <http://www.python.org/download/>`_ (version 2.5+, but
not version 3.x) and `Pygame <http://www.pygame.org/download.shtml>`_ (version
1.7+).

Linux/FreeBSD
-------------
You almost certainly have Python already installed, and there are probably
Pygame packages available via the package management system. Debian-based
distros have `python-pygame`, openSUSE has `python-pygame`, Fedora has
`pygame`, and FreeBSD has `py25-game` (for example).

To start Pyskool in Skool Daze mode, open a terminal window, change to the
Pyskool directory, and do::

 $ ./skool_daze.py

or, to run Pyskool in Back to Skool mode::

 $ ./back_to_skool.py

Mac OS X
--------
When Python and Pygame are installed, open a terminal window, change to the
Pyskool directory, and do::

  $ ./skool_daze.py

to run Pyskool in Skool Daze mode; or, to run Pyskool in Back to Skool mode::

  $ ./back_to_skool.py

Windows
-------
When Python and Pygame are installed, double-click the `skool_daze.py` file in
the Pyskool directory. To run Pyskool in Back to Skool mode, double-click
`back_to_skool.py`.

If that doesn't work, try the command line. Open a command prompt, change to
the Pyskool directory, and do::

  > skool_daze.py

to run Pyskool in Skool Daze mode; or, to run Pyskool in Back to Skool mode::

  > back_to_skool.py

Command line options
--------------------
The `skool_daze.py` and `back_to_skool.py` executables support a few command
line options:

* ``--version`` - show the version number of Pyskool
* ``-h`` or ``--help`` - show a summary of the available options
* ``-s`` or ``--scale`` - set the scale of the display; overrides the `Scale`
  setting in the :ref:`screenConfig` section
* ``-i`` or ``--inidir`` - use ini files from a specified directory
* ``-q`` or ``--quick-start`` - start the game quickly by skipping the
  scroll-skool-into-view and theme tune sequence; overrides the `QuickStart`
  setting in the :ref:`gameConfig` section
* ``-c`` or ``--cheat`` - enable cheat keys; overrides the `Cheat` setting in
  the :ref:`gameConfig`
* ``-l`` or ``--load`` - load a previously saved game
* ``-r`` or ``--load-last`` - load the most recently saved game in a directory
