Dokumentacja

README

@@ -1,10 +0,0 @@
-Zestaw skryptów do TF-a przystosowany do Arkadii i Nightala.
-
-Autorem jest głównie Werbat, ale część kodu jest zerżnięta od innych
-(odpowiednie adnotacje znajdują się przy kodzie obcego autorstwa).
-
-Instrukcja konfiguracji i uruchomienia:
-
-1) git clone https://bitbucket.org/ftpd/tf-scripts.git ~/tf
-2) cp ~/tf/_tfrc ~/.tfrc
-3) tf

README.markdown

@@ -0,0 +1,21 @@
+Skrypty do [TinyFugue](http://tinyfugue.sourceforge.net) przystosowane do polskich LP-mudów: [Arkadii](http://arkadia.pl) (rozwijane aktywnie) oraz [Nightala](http://nightal.pl) (obecnie zawieszone). Do poprawnego działania wymagają tf-a w wersji __co najmniej 5.0b8__.
+
+Disclaimer:
+-----------
+
+Autorem jestem w większości ja, ale część kodu jest zerżnięta od innych - dpowiednie adnotacje znajdują się przy kodzie obcego autorstwa. Jeśli skrypty zawierają Twój kod, a nie jesteś wymieniony jako autor i/lub chcesz, żeby go wywalić z paczki, [daj znać](http://insomniac.pl/info/contact).
+
+Instrukcja używania znajduje się w pliku [HELP.markdown](_doc/HELP.markdown).
+
+Instalacja:
+===========
+
+Pierwsze pobranie:
+------------------
+- rm -rf ~/tf
+- git clone https://bitbucket.org/ftpd/tf-scripts.git ~/tf
+- cp ~/tf/tfrc ~/.tfrc
+
+Aktualizacja:
+-------------
+- cd tf && git reset --hard && git clean -fd && git pull

_doc/HELP.markdown

@@ -0,0 +1,167 @@
+# Informacje ogólne
+
+## Notacja użyta w instrukcji:
+
+| |
+| - | - |
+| {ścieżka} | - ściezka do pliku na dysku |
+| _kursywa_ | - bezpośrednia komenda występująca na mudzie |
+| `tekst w ramce` | - dokładna komenda do wpisania |
+| <tekst> | - zmienna |
+| [tekst] | - zmienna opcjonalna |
+
+## Plik postaci
+
+Po pierwszym uruchomieniu skryptów tworzony jest katalog ukryty {~/.tf] zawierający ustawienia dotyczące konkretnych postaci. Po pierwszym zalogowaniu się na daną powstać powstaje plik {~/.tf/<nazwa-muda>/<imie-postaci>/<imie-postaci>.tf}, będący kopią [stdplayer.tf](../common/stdplayer.tf). W pliku tym należy ustawić kilka podstawowych zmiennych (plik zawiera komentarze, co która zmienna oznacza).  
+
+## Własne modyfikacje
+
+__UWAGA:__ Skrypty w katalogu {~/tf} nie powinny być zmieniane przez użytkownika. Ewentualne zmiany zostaną nadpisane podczas aktualizacji skryptów. Wszelkie własne zmiany powinny być wprowadzane __wyłącznie__ w pliku postaci (lub innym miejscu w katalogu {~/.tf}). Przykładowe tworzenie aliasów i komend:
+
+| |
+| - | - |
+| `/alias pod podskocz` | - tworzy aliasa `pod` wykonującego _podskocz_ |
+| `/def pod = podskocz` | - tworzy komendę `/pod` wykonującą _podskocz_ |
+
+# Bindy
+
+## Klawiatura podstawowa
+
+| |
+| - | - |
+| `F1` - `F8` | - ustawiane przez użytkownika komendami `/f1`, `/f2`, ..., `/fn` |
+| `F9` | - _zabij <cel>_ (ustawiany komendą `/cel`) |
+| `Esc + F9` | - _przelam obrone <celu>_ (ustawianego komendą `/cel`) |
+| `F10` | - _zabij <cel2>_ (ustawiany komendą `/cel2`) |
+| `Esc + F10` | - _przelam obrone <celu2>_ (ustawianego komendą `/cel2`) |
+| `F11` | - _przestan walczyc_ |
+| `F12` | - autołazik (opisany w sekcji "Łazik") |
+| `[` | - atak na wskazanego |
+| `]` | - przelamanie wskazanego |
+
+## Klawiatura numeryczna
+
+| |
+| - | - |
+| `/` | - normalne chodzenie |
+| `*` | - przemykanie |
+| `-` | - przemykanie z drużyną |
+| `5` | - ruch łazika na kolejną lokację (opisany w sekcji "Łazik") |
+| `+` | - _gora_ |
+| `.` | - _dol_ |
+| `Enter` | - _kondycja wszystkich_ |
+| `0` | - _stan_ |
+
+## Bind dynamiczny
+
+Klawisz odwrotnego apostrofu (\`) binduje się dynamicznie zależnie od tekstu otrzymanego od muda na komendy typu _zapal lampe_ albo _zapukaj w brame_. Jego działanie jest jednorazowe, czyli po naciśnięciu bind zostaje usunięty.
+
+# Pasek stanu
+
+![pasek](https://bitbucket.org/ftpd/tf-scripts/raw/readme/_doc/pasek.png)
+
+| |
+| - | - |
+| __róża wiatrów__ | - pokazuje możliwe wyjścia z lokacji (innym kolorem zaznaczony jest kierunek, z którego przyszła postać |
+| __K:__ | - kondycja |
+| __Z:__ | - zmęczenie |
+| __B:__ | - próba blokowania lub udane zablokowanie (zarówno przez siebie, jak i przeciwko sobie) |
+| __W:__ | - warning, na przykład ogłuszenie lub wytrącenie broni |
+| __R:__ | - kto aktualnie został wskazany jako rozkaz ataku |
+| __Hide:__ | - ukrycie |
+| __Sneak:__ | - przemykanie |
+| __Mail:__ | - status poczty. Przyjmuje wartości: MAIL (jeden otrzymany list), MSG (jedna wiadomość), MULTI (kilka listów i/lub wiadomości) |
+| __Zasl:__ | - gotowość do zasłony lub czas pozostały do następnej próby |
+| __Order:__ | - gotowość do wydania rozkazu lub czas pozostały do nastepnej próby |
+| __Warn:__ | - ostrzeżenie, np. o walce bez broni |
+| __Bind:__ | - aktualna komenda przypięta do binda dynamicznego (opisanego w sekcji "Bindy / Bind dynamiczny") |
+| __<liczba>/<liczba>__ | - zabici przez siebie / polegli w ogóle od zalogowania |
+
+# Komendy
+
+## Techniczne
+
+| |
+| - | - |
+| `/c` | - czyści ekran |
+| `/fk <tekst>` | - wyswietla <tekst> tak, jakby przyszedł od muda - przydatne do testowania skryptów |
+| `/ack` | - czyści bind dynamiczny, informacje "Warning" na pasku itp. |
+| `/reload` | - przeładowuje skrypty (jednocześnie kasując wszelkie dopisane 'z palca' zmiany, aliasy itp.) |
+| `/ktoto <tekst>` | - szuka pasujących wystapień <tekst> w bazie imion |
+| `/typo <foo> <bar>` | - wpisane <foo> wysyła do muda <bar>. Przydatne do skracania sobie trudnych do wpisania nazw |
+| `/testuj` | - wysyła do muda mnóstwo komend i wyświetla te, których wpisanie spowodowało coś innego, niż _Slucham?_. Przydatne do zgadywania właściwej komendy itp. |
+| `/glow <tekst>` | - włącza kolorowanie <tekst> aż do nastepnego `/reload` lub `/unglow` |
+| `/unglow <tekst>` | - wyłącza kolorowanie <tekst>
+
+## Ogólne
+
+| |
+| - | - |
+| `/f1 <komenda>` - `/f8 <komenda>` | - binduje klawisze `f1` - `F8` pod wskazane komendy |
+| `/kowal` | - rozpoczyna naprawę broni i zbroi |
+| `/poczta` | - wyświetla informacje o otrzymanych listach i/lub wiadomościach |
+| `/exp` | - medytuje, ocenia cechy i wstaje |
+
+## Bojowe
+
+| |
+| - | - |
+| `/comp <kim>` | - porównuje cechy bojowe z <kim> |
+| `/cel <kogo>` | - ustawia <kogo> jako cel ataku i łamania | 
+| `/cel2 <kogo>` | - analogicznie do `/cel <kogo>`, drugi cel ataku |
+| `/am` | - wyświetla dostępne tryby ataku oraz informuje o aktualnie ustawionym |
+| `/am <numer>` | - ustawia tryb ataku o danym numerze |
+| `/zabici` | - pokazuje statystyki zabitych przez siebie i innych |
+
+## Poruszanie się
+
+| |
+| - | - |
+| `/idz <kierunek>` | - uruchamia łazika we wskazanym <kierunek> |
+| `/delay <liczba>` | - ustawia szybkość łazika na <liczba> sekund |
+| `/wns` | - wsiadanie na statek (wyjęcie monet, kupienie biletu itp.) |
+| `/wdyl` | - wsiadanie do dyliżansu (wyjęcie monet, kupienie biletu itp.) |
+
+## Ekwipunek
+
+| |
+| - | - |
+| `/op` | - zagląda do pojemnika (plecaka, torby, sakwy itp. - rozpoznawane automatycznie przy zakładaniu) |
+| `/dp <co>` | - wkłada do pojemnika <co> |
+| `/zp <co>` | - wyjmuje z pojemnika <co> |
+| `/np` | - _napelnij plecak_ (lub inny pojemnik) |
+| `/sd` | - zdejmuje wszystkie zbroje i wkłada je do pojemnika |
+| `/sz` | - wyjmuje wszystkie zbroje z pojemnika i zakłada je |
+| `/bd` | - opuszcza broń i chowa ją do pojemnika lub pochwy (zależnie od ustawień w pliku postaci) |
+| `/bz` | - wyjmuje broń z pojemnika lub pochwy (zależnie od ustawień w pliku postaci) i dobywajej |
+| `/dw <co>` | - wkłada <co> do (pierwszego) woreczka |
+| `/zw <co>` | - wyjmuje <co> z (pierwszego woreczka)|
+| `/d2w` - `/d8w` | - analogicznie do `/dw`, dla drugiego - ósmego woreczka |
+| `/z2w` - `/z8w` | - analogicznie do `/zw`, dla drugiego - ósmego woreczka |
+| `/wycen <co>` | - wycenia wszystkie <co> w sklepie i pokazuje podsumowany zysk w najwyższych możliwych nominałach |
+| `/ocenkamienie` | - ocenia kamienie i wyświetla ich szacowaną wartość w najwyższych możliwych nominałach |
+
+# Listy
+
+Mechanizm list służy do kolorowaia imion i/lub opisów innych postaci (oczywiście nic nie stoi na przeszkodzie, żeby kolorować nim cokolwiek innego - to po prostu lista wyrażeń, które będą pokolorowane tak, jak zdefiniowana jest lista ;-)). Możliwe do użycia komendy:
+
+| |
+| - | - |
+| `/dodaj liste <nazwa listy> <kolor> [kolor tla]` | - dodaje listę o podanej nazwie i zdefiniowanych kolorach |
+| `/dodaj <nazwa listy> <wyrazenie>` | - dodaje dane wyrażenie (również reglarne!) do listy |
+| `/zmien <nazwa listy> <kolor> [kolor tla]` | - zmienia kolorowanie podanej listy |
+| `/wyswietl listy` | - pokazuje aktualnie zdefiniowane listy |
+| `/wyswietl <nazwa listy>` | - pokazuje wyrażenia dodane do podanej listy |
+| `/usun liste <nazwa listy>` | - usuwa listę |
+| `/usun <nazwa listy> <wyrazenie>` | - usuwa dane wyrażenie z podanej listy |
+
+# Łazik
+
+- klawisz `F12` inicjuje łazik, który idzie do najbliższego skrzyżowania. Odstęp czasowy między lokacjami definiowany jest komendą `/delay`.
+- klawisz `5` na klawiaturze numerycznej powoduje ruch o jedną lokację - na lokacjach z dwoma wyjściami pójdzie w stronę, z której postać nie przyszła (przydatne na traktach - można klikać co żądany czas `5` zamiast wpisywać kierunki). Inicjowany na lokacji z więcej niż dwoma wyjściami nie robi nic.
+
+# Drużyna
+
+Przy zmianie drużyny (dołączanie, opuszczanie, zmiana przywódcy, przekazanie itp.) należy wcisnąć kombinację klawiszy `Control + d`. Dzięki temu podczas wywołania komendy _kondycja wszystkich_ przy członkach drużyny pojawią się klawisze przypisane do danej osoby (z zakresu f1 - f8). Wciśnięcie kombinacji `Esc + <klawisz>` będzie próbowało daną osobę zasłonić.  
+
+__UWAGA:__ skryptowi do odmiany daleko do doskonałości. Trzeba dopisywać wyjątki - póki co staram się wpisywać je globalnie (docelowo będzie to przeniesione do plików prywatnych w katalogu _~/.tf_), dlatego najlepiej będzie przypadki do dopisania [zgłosić](https://bitbucket.org/ftpd/tf-scripts/issues) - skorzystają na tym wszyscy użytkownicy skryptów.