BACK_TO_SKOOL_DAZE.PY(6)

NAME
back_to_skool_daze.py - run Pyskool in Back to Skool Daze mode

SYNOPSIS

back_to_skool_daze.py [options]

DESCRIPTION

back_to_skool_daze.py runs Pyskool in Back to Skool Daze mode. Pyskool is a remake of the classic ZX Spectrum games Skool Daze and Back to Skool by Microsphere.

OPTIONS

--version
    Show Pyskool's version number and exit.

-h, --help
    Show a summary of the available options.

-c, --cheat
    Enable cheat keys.

--create-images, --get-images
    Create the images required by the game in ~/.pyskool/images and exit.

--create-ini
    Create the ini files required by the game in ~/.pyskool/ini/back_to_skool_daze and exit.

--create-sounds
    Create the sound files required by the game in ~/.pyskool/sounds and exit.

--force
    Overwrite existing images, ini files and sound files (when using the --create-images, --create-ini, --create-sounds or --setup option).

-i, --inidir INIDIR
    Read ini files from this directory instead of ini/back_to_skool_daze.

-l, --load SAVEFILE
    Load a saved game from the specified file.

--package-dir
    Show the path to the pyskool package directory and exit.

-q, --quick-start
    Start the game quickly by skipping the scroll-skool-into-view and theme tune sequence.

-r, --load-last SAVEDIR
    Load the most recently saved game in the specified directory.

--sample-rate RATE
    Set the sample rate of the sound files created by --create-sounds. The default sample rate is 44100.

-s, --scale SCALE
    Scale graphics by this factor (1=original Speccy size).

--search-dirs
    Show the locations that Pyskool searches for data files and exit.

--setup
    Create the images, ini files and sound files required by the game in ~/.pyskool and exit. This option is equivalent to combining the --create-images, --create-ini and --create-sounds options.

FILES

When Pyskool starts in Back to Skool Daze mode, it looks for the following things:
- a file named pyskool.ini (the main ini file)
- a directory named images
- a directory named sounds
- a directory named ini/back_to_skool_daze

Each of these things must be present in one of the following directories in order for Pyskool to find it:
- the current working directory
- ~/.pyskool
- the directory containing back_to_skool_daze.py
- /usr/share/pyskool
- $PACKAGE_DIR/data

where $PACKAGE_DIR is the directory in which the pyskool package is installed, as shown by:
back_to_skool_daze.py --package-dir

When you need a reminder of these locations, run:
back_to_skool_daze.py --search-dirs

IMAGES

The --create-images option first looks for Skool Daze and Back to Skool tape or snapshot files by the following names in ~/.pyskool:
skool_daze.tzx
skool_daze.sna
skool_daze.z80
skool_daze.szx
back_to_skool.tzx
back_to_skool.sna
back_to_skool.z80
back_to_skool.szx

If no such files are found, TZX files are downloaded from one of the sources listed in images.ini and saved to ~/.pyskool. Then the required images are built from the tape or snapshot files and saved to the appropriate subdirectories under ~/.pyskool/images/originalx1.

SEE ALSO

skool_daze.py(6), back_to_skool.py(6), skool_daze_take_too.py(6), ezad_looks.py(6).

AUTHOR
Richard Dymond

COPYRIGHT
2014, Richard Dymond