##########################################################
#							 #
#	Dokumentacja do skryptu 'Mucha ver1.0'           #
#							 #
#	Autorzy:					 #
#	Bartosz Masowski				 #
#	Przemysaw Rycki				 #
#							 #
##########################################################

SPIS TRECI:
============

1. OPIS SKRYPTU
2. INSTALACJA SKRYPTU
3. KONFIGURACJA SKRYPTU
4. KONTAKT Z AUTORAMI



1. OPIS SKRYPTU
===============

Prezentowany tu skrypt napisany jest w jzyku JavaScript i przeznaczony jest do umieszczenia na
dowolnej stronie internetowej o charakterze rozrywkowym. Dziaanie skryptu polega na wygenerowaniu
obiektu, nazwywanego dalej much (cho moe to by dowolny objekt - patrz rozdzia 3 'KONFIGURACJA
SKRYPTU'), ktra poda za poruszajcym si po ekranie kursorem myszki. Jest to zrealizowane z pewnym
opnieniem co sprawia wraenie jakby mucha gonia kursor. Do tego mucha jest animowana i moe skada
si z dowolnej liczby klatek co umoliwia tworzenie bardziej wyszukanych obiektw. Poza poruszaniem
si po ekranie, mucha ma jeszcze jedn ciekaw wasno. W momencie gdy znajdzie si dokadnie nad
kursorem myszki (na odpowidniej wysokoci nad nim - patrz rozdzia 3 'KONFIGURACJA SKRYPTU), to mucha
po upywie chwili zdefiniowanej przez uytkownika (patrz rozdzia 3) zaczyna zaatwia swoje potrzeby
fizjologiczne...i to wprost na nasz kursor!!! (jeli oczywicie nie zdrzymy uciec :) ). Generowany
w trakcie tego procesu 'obiekt' rwnie jest animowany i dodatkowo po 'upadku' na kursor zmienia swj
wygld na wskazany przez uytkownika. Zalet skryptu jest moliwo takiego przekonfigurowania,
e moemy go nawet zamieci na stronie o charakterze religijnym zmieniajc np. much w anioka
a generowane przez niego obiekty np. w gwiazdki lub zrobi witego Mikoaja rozrzucjacego prezenty!
Umoliwia to nam wykorzystanie tego skrytpu na stronie o dowlnym  charakterze.

2. INSTALACJA SKRYPTU
=====================

Wywyanie skryptu (mucha.js) najlepiej jest umieci wewntrz znacznikw <head> strony docelowej.
Robimy to w nastpujcy sposb:

<head>
<script language='javascript' src='mucha.js'>
<!--
-->
</script>
</head>

,gdzie src='scieka_dostpu_do_skryptu_wraz_z_jego_nazw'.


3. KONFIGURACJA SKRYPTU
=======================

Skrypt konfigurujemy bezporednio w pliku mucha.js. Tak wic otwieramy plik do edycji i odszukujemy blok
zmiennych oznaczony jako 'Konfiguracja'. Teraz zmieniajc wartoci tych zmiennych ingerujemy w
dziaanie caego skryptu. Oto opis dostpnych opcji:

- var mucha_x		okrela pocztkowe pooenie w poziomie obiektu muchy na ekranie (w pikselach)
- var mucha_y		okrela pocztkowe pooenie w pionie obiektu muchy na ekranie (w pikselach)
- var l_klatek  	okrela liczb klatek z jakiej skada si animacja obiektu muchy     
- var l_klatek_k  	okrela liczb klatek z jakiej skada si animacja obiektu generowanego przez much
- var wys		okresla wyskoko nad kursorem na jak nadlatuje mucha (w pikselach)
- var max_k             maksymalna liczba obiektw jakich moe wygenerowa mucha - po przekroczeniu tej 			l	iczby nastpuje ich stopniowe zastpowanie nowymi obiektami.
- var plik		nazwa 'bazowa' pliku muchy - czyli ta jej cz powstaa z dowolnego pliku bdcego 			klatk animacji muchy po wyciciu z nigo czci odpowiedzialnej za numeracj klatki
- var plik_k            nazwa 'bazowa' pliku obiektu (generowanego przez much) podczas spadania
- var plik_kk		nazwa 'bazowa' pliku obiektu (generowanego przez much) po upadku
- var czas		czas w jednostkach niemianowanych po jakim mucha zaczyna zaatwia swoje
			potrzeby fizjologiczne. Czym wiksza liczba tym duszy czas. (uywamy liczb 					nieujemnych)

Dodatkowe uwagi:
----------------

Pliki z klatkami animacji obu obiektw zapisujemy w formacie GIF ich nazwy tworzc w nastpujcy
sposb:

[nazwa_bazowa][numer_klatki].gif

Midzy nazw bazow a numerem klatki nie ma adnego odstpu a nawiasy [] zostay jedynie uyte w celu logicznego odseparowania obu czonw.

przykad:

mucha1.gif  => nazwa_bazowa=mucha ; numer_klatki=1
mucha24.gif  => nazwa_bazowa=mucha ; numer_klatki=24
mikolaj13.gif  => nazwa_bazowa=mikolaj ; numer_klatki=13

Pliki te umieszczamy w tym samym katalogu co skrypt.

4. KONTAKT Z AUTORAMI
=====================

Autorzy skryptu:

Bartosz Masowski i Przemysaw Rycki

adres kontaktowy e-mail: maser@widzew.net

 