tf-scripts/_doc/HELP.md

197 lines
11 KiB
Markdown

# 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 |
## Podstawowe ustawienia
W pliku {~/.tfrc} (skopiowanym z [tfrc](../tfrc)) należy ustawić podstawowe zmienne: schemat kolorów, typ klawiatury oraz ścieżkę do katalogu z logami.
Po pierwszym zalogowaniu się na daną powstać powstaje plik {~/.tf/<nazwa-muda>/<imie-postaci>/<imie-postaci>.tf}, będący kopią [common/std/player.tf](../common/std/player.tf). W pliku tym należy ustawić kilka podstawowych zmiennych dotyczących ekwipunku itp.
Oba pliki zawierają komentarze informujące o tym, co oznacza która zmienna i jakie wartości może przyjmować.
## 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_ |
| `/def pod2 = podskocz%; sp` | - tworzy komendę `/pod` wykonującą _podskocz_, a potem _sp_ (w TF-ie komendy rozdziela się sekwencją %;) |
# Bindy
## Klawiatura podstawowa
| |
| - | - |
| `F1` - `F8` | - ustawiane przez użytkownika komendami `/f1`, `/f2`, ..., `/f8` |
| `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` | - następna lokacja (szerzej opisane w sekcji "Łazik") |
| `[` | - atak na cel ataku |
| `]` | - przełamanie celu ataku |
## Klawiatura numeryczna
| |
| - | - |
| `/` | - normalne chodzenie |
| `*` | - przemykanie |
| `-` | - przemykanie z drużyną |
| `5` | - następna lokacja (szerzej opisane 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/master/_doc/pasek.png)
| |
| - | - |
| __róża wiatrów__ | - pokazuje możliwe wyjścia z lokacji (innym kolorem zaznaczony jest kierunek, z którego postać przyszła) |
| __K:__ | - kondycja |
| __Z:__ | - zmęczenie |
| __M:__ | - mana |
| __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 |
| __B:__ | - aktualna komenda przypięta do binda dynamicznego (opisanego w sekcji "Bindy / Bind dynamiczny") |
| __Hidden:__ | - ukrycie (przyjmuje wartości ON/off) |
| __Sneaky:__ | - przemykanie zamiast chodzenia (przyjmuje wartości ON/GRP/off) |
| __Weapon:__ | - status broni (przyjmuje wartości (ON/ERR/off) |
| __Cover:__ | - 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 |
| __Alert:__ | - ostrzeżenie, np. o walce bez broni |
| __Mail:__ | - status poczty (NEW - jeden list, NEW+ - więcej listów, READ - list do odczytania lokalnie, SEND - list oczekuje na wysłanie, SYNC - w trakcie aktualizacji (przez zwierzątko pocztowe)) |
| __F:__ | - forma (przyjmuje wartości od 0 (_jestes w przecietnej formie_) do 6 (_jestes w nieziemskiej formie_)) |
| __L:__ | - obciążenie (przyjmuje wartości od 0 (_nie wadzi_) do 6 (_przygniata do ziemi_)) |
| __D:__ | - upicie (przyjmuje wartości od -6 (_masz potwornego kaca_) do +10 (_jestes pijany jak bela_)) |
| __P:__ | - strach (przyjmuje wartości od 0 (_czujesz sie bezpiecznie_) do 5 (_czujesz sie bardzo przerazony_)) |
| __T:__ | - pragnienie (przyjmuje wartości od 0 (_nie chce ci sie pic_) do 3 (_chce ci sie bardzo pic_)) |
| __H:__ | - głód (przyjmuje wartości od -2 (_jestes bardzo glodny_) do +2 (_jestes bardzo najedzony_)) |
| __Enemies:__ | - liczba wrogów koncentrujących się na walce z postacią (odświeżane przy sprawdzaniu kondycji) |
| __Kill:__ | - 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 w polu "Alert" na pasku itp. |
| `/reload` | - przeładowuje skrypty (jednocześnie kasując wszelkie dopisane 'z palca' zmiany, aliasy itp.) |
| `/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>
## Informacyjne
| |
| - | - |
| `/exp` | - licznik cech przy medytowaniu (__UWAGA:__ może nie działać na poziomach niższych niż pewnie stąpa) |
| `/stats` | - pokazuje statystyki defensów, zbroi, tarczy i speca |
| `/zabici` | - pokazuje statystyki zabitych przez siebie i innych |
| `/postepy` | - pokazuje czas osiągnięcia kolejnych postępów oraz liczbę zabitych przez siebie/przez wszystkich w tym momencie |
| `/ktoto <tekst>` | - szuka pasujących wystapień <tekst> w bazie imion |
## Ogólne
| |
| - | - |
| `/f1 <komenda>` - `/f8 <komenda>` | - binduje klawisze `F1` - `F8` pod wskazane komendy |
| `/kowal` | - rozpoczyna naprawę broni i zbroi |
| `/ciuchy` | - rozpoczyna naprawę ubrań |
| `/poczta` | - wyświetla informacje o otrzymanych listach i/lub wiadomościach |
## 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 |
## Poruszanie się
| |
| - | - |
| `/wns` | - wsiadanie na statek (wyjęcie monet, kupienie biletu itp.) |
| `/wdyl` | - wsiadanie do dyliżansu (wyjęcie monet, kupienie biletu itp.) |
| `/walkcmd` | - ustawia komendę, która zostanie wykonana każdorazowo po zmianie lokacji (`/walkcmd off` aby wyłączyć) |
## Ekwipunek
| |
| - | - |
| `/op` | - zagląda do pojemnika (plecaka, torby, sakwy itp. - rozpoznawane automatycznie przy zakładaniu) |
| `/zp <co>` | - wyjmuje z pojemnika <co> |
| `/dp <co>` | - wkłada do pojemnika <co> |
| `/np` | - _napelnij plecak_ (lub inny pojemnik) |
| `/sz` | - wyjmuje wszystkie zbroje z pojemnika i zakłada je |
| `/sd` | - zdejmuje wszystkie zbroje i wkłada je do pojemnika |
| `/bz` | - wyjmuje broń z pojemnika lub pochwy (zależnie od ustawień w pliku postaci) i dobywajej |
| `/bd` | - opuszcza broń i chowa ją do pojemnika lub pochwy (zależnie od ustawień w pliku postaci) |
| `/szz` | - wyjmuje sztylet i dobywa go (dla zawodów bez broni ciętych noszących dodatkowo sztylet) |
| `/szd` | - opuszcza sztylet i chowa go (dla zawodów bez broni ciętych noszących dodatkowo sztylet) |
| `/bron <on/off>` | - bardziej przyjazna komenda do dobywania broni |
| `/zbroja <on/off>` | - bardziej przyjazna komenda do zakładania zbroi |
| `/sztylet <on/off>` | - bardziej przyjazna komenda do dobywania sztyletu |
| `/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 |
| `/ocenkamienie` | - ocenia kamienie i wyświetla ich szacowaną wartość w najwyższych możliwych nominałach |
# Schematy kolorów
Kolory w skryptach definiowane są globalnie w pliku [colorscheme.tf](../common/colorscheme.tf). Własne kolory można uzyskać edytując pojedynczo odpowiednie zmienne (oczywiście __poza__ katalogiem {~/tf}, najlepiej w pliku postaci) lub poprzez redefinicję całego `/def _colorscheme_load`.
__UWAGA__ oprócz zdefiniowanych w skryptach kolorów należy ustawić sobie kolor wyjść już z poziomu samej arkadii (`kolor opisy wyjsc z lokacji <nazwa|numer>`).
# 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
Klawisze `5` na klawiaturze numerycznej oraz `F12` na zwykłej powodują 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ć klawisz zamiast wpisywać kierunki). Inicjowany na lokacji z więcej niż dwoma wyjściami nie robi nic.
Chodzenie w ten sposób uwzględnia tryb chodzenia (zwykłe/przemykanie/przemykanie z drużyną).
# 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` - `F12`). Wciśnięcie kombinacji `Esc + <klawisz>` będzie próbowało daną osobę zasłonić.
__UWAGA:__ skryptowi do odmiany daleko do doskonałości. Czasami w pliku {~/.tf/<nazwa muda>/exceptions.tf} trzeba sobie dopisać wyjątek. Przykładowe znajdują się w [common/std/exceptions.tf](../common/std/exceptions.tf) i są kopiowane do {~/.tf} podczas pierwszego uruchomienia skryptów.