# -copyright-
#-# 
#-# Copyright (C) 1999-2001  Robin Hogan, 2021-2024 Willem Vermin
#-# 
#-# This program is free software; you can redistribute it and/or modify
#-# it under the terms of the GNU General Public License as published by
#-# the Free Software Foundation; either version 2 of the License, or
#-# (at your option) any later version.
#-# 
#-# This program is distributed in the hope that it will be useful,
#-# but WITHOUT ANY WARRANTY; without even the implied warranty of
#-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#-# GNU General Public License for more details.
#-# 
#-# You should have received a copy of the GNU General Public License
#-# along with this program; if not, write to the Free Software
#-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#-# 

XPENGUINS - cool little penguins walking along the tops of your windows
Copyright (C) 1999-2001  Robin Hogan
Version: 2.2 (1 October 2001)

INTRODUCTION

XPenguins is a program for animating cute cartoons/animals in your
root window. By default it will be penguins - they fall from the top
of the screen, walk along the top of windows, up the side of windows
and do various other stuff. Other themes in the base package are "Big
Penguins" (50% bigger), "Classic Penguins" (reproducing XPenguins
version 1.2), "Turtles", and "Bill".  More themes can be downloaded
from the XPenguins web site (http://xpenguins.seul.org/) - version 0.9
of the xpenguins_themes package contains "The Simpsons", "Sonic the
Hedgehog", "Lemmings" and "Winnie the Pooh".

To run the program, type "xpenguins" at the console. Type "xpenguins
--help" to see the available options, or read the man page (type "man
xpenguins"). If you want to make your own theme, read the THEMES
section of the man page and have a look at the config file for the
default theme (which is usually installed in
/usr/share/xpenguins/themes/Penguins/config). You may also find the
gimp scripts "lay-out-frames.scm" and "resize-frames.scm" useful - the
first lays out the frames of an animated gif side by side in a way
that can be used by XPenguins, and the second resizes an XPenguins
image frame by frame to avoid bleeding of colors between adjacent
frames.

RUNNING IN VARIOUS DESKTOPS

Since version 3.0.0, xpenguins is expected to run in 'all' Linux
desktop environments, it should also run in freebsd, openbsd etc.

INSTALLATION

Do the following:

	./configure
	make
	make install (as root)

By default everything will be installed in /usr/local. Use
"./configure --prefix=/usr" (or similar) to install it somewhere
else. For more information, read the INSTALL file, or type "./configre
--help". If you have problems with the make process then try using
"gmake" instead of "make".

If above recipe fails, have a look at 'simplemake.sh', a commented
script that compiles xpenguins.

DEVELOPMENT

For developers: the script 'bootstrap' creates a new configure sccript
and plugs the copyright paragraph in the files.

The version of xpenguins id defined in configure.ac:
the line with AC_INIT.


LICENSE

This program is released under the GNU general public license - see
the COPYING file. This license applies to everything in the base
distribution, including the themes "Penguins", "Classic Penguins",
"Big Penguins", "Turtles" and "Bill".


CODE GUIDE

You are welcome to modify or borrow any of this code, under the
conditions of the GNU GPL.  The code is in the src directory and is
organised as follows:

The toon_*.c files contain functions for animating images on the root
(or other) window. They also hide the X calls from higher-level
code. Each function is prefixed with "Toon" - you can see which
functions are in which file by looking at the header file toon.h. 

Since version 3.0.0, xpenguins uses gtk3 to create a transparent
click-through window to draw the peguins in. That should be possible
using only X11, but I do not know how to do that. If such a window
is not possible, xpenguins uses the root window to draw in, or
in the case of LXDE, the window with the name 'pcmanfm'.

The xpenguins_*.c files contain functions (prefixed with xpenguins_)
that load themes and govern the behaviour of the penguins. The header
file xpenguins.h describes briefly what each function does. The user
interface code then interprets the various user-supplied options and
implements them by calling xpenguins functions; in this way different
XPenguins front ends produce penguins that behave in the same
way. This package is the command-line version - the front-end code is
in main.c. The GNOME graphical front (the xpenguins_applet package)
uses exactly the same toon and xpenguins files. Therefore if you make
a modification to the program that you would like me to include in a
future release, please do it in such a way that it will work in all
versions.


ACKNOWLEDGEMENTS

Inspiration was provided by Rick Jansen <rick@sara.nl> in the form of
the classic "xsnow".

Many of the penguin images were taken from "Pingus", a free lemmings
clone for Linux (http://pingus.seul.org/), and were designed by Joel
Fauche <joel.fauche@wanadoo.fr> and Craig Timpany
<timpany@es.co.nz>. Rob Gietema <tycoon@planetdescent.com> provided
some new penguin images now used in the default theme.


AUTHORS

Robin Hogan <R.J.Hogan@reading.ac.uk>
Willem Vermin <willem@ratrabbit.nl>

The XPenguins homepage is located at http://xpenguins.seul.org/
The 3.0.0 and higher version are on 
         https://ratrabbit.nl/ratrabbit/software/xpenguins


SEE ALSO

Michael Vines <isamu@neomueller.org> has rewritten the program (as of
version 1.1) for Microsoft Windows and called it "WinPenguins" -
visit http://neomueller.org/~isamu/winpenguins/ 

