konfiguracja

Konfiguracja

1. Opis konfiguracji

System konfiguracji dziala na nastepujacych zasadach

Konfiguracja trzymana jest w pliku o rozszerzeniu json. Jest to prosty i czytelny format, ktory umozliwia edycje konfiguracji rowniez w samym pliku.
Konfiguracje mozna edytowac zarowno podczas samej gry jak i "offline" w pliku. Edytujac podczas gry jest mozliwosc na automatyczne przeladowanie odpowiednich modulow.
Aby zaczac korzystac z nowego systemu konfiguracji nalezy albo (1) stworzyc nowy, startowy konfig i go zedytowac, badz (2) skorzystac z migracji.

2. Zmienne konfiguracyjne

Cala konfiguracja opiera sie na prostej zasadzie "zmienna" -> "ustawienie". Przyklad ponizej ukazuje 5 zmiennych z icn ustawieniami:

{
  "ateam.all_numbering": true,
  "herbs.many_to_int": 40,
  "herbs.post_actions": "wloz woreczki do swojego plecaka",
  "herbs.pre_actions": "wez woreczki ze swojego plecaka",
  "herbs.settings.get_herb_counts": [1,3],
  "herbs.settings.use_herb_counts": [1,3],
  "scripts.ui.cfg.footer_items": ["zmeczenie","forma","mana","pragnienie"]
  "scripts.ui.cfg.states_window_nav_printable_key_map": {"bron": "BRON","rozkaz": "ROZKAZ"},
}

Format to:

"[nazwa_zmiennej]": [jakies_ustawienie]

Ustawienie zmiennej moze miec jeden z nastepujacych typow:

string (przyklad: "wloz woreczki do swojego plecaka"
)
number (liczba calkowita badz zmiennoprzecinkowa, przyklad: 40
lub 3.8
)
boolean (true
albo false
)
list (lista zmiennych, jakichkolwiek typow powyzej, przyklad: ["zmeczenie","forma","mana","pragnienie"]
)
map (slownik danych, czyli klucz->wartosc, przyklad: {"bron": "BRON","rozkaz": "ROZKAZ"}
)

Typy (1), (2) oraz (3) to typy podstawowe. Lista (4) oraz mapa (5) jako klucze i/lub wartosci moze zawierac wszystkie podstawowe typy.

3. Jak zaczac uzywac konfiguracji v2?

3.1 Migracja ze starego systemu (z imie.txt)

UWAGA: Najpierw nalezy zrestartowac Mudleta, zalogowac sie i zaladowac stary plik imie.txt.

Aby dokonac migracji z obecnego systemu nalezy skorzystac z aliasa /cmigrate [nazwa_pliku_imie]
. Czyli, jesli w moim katalogu profilu mam plik "erkal.txt" to bedzie to /cmigrate erkal
. Jesli zas w moim katalogu profilu mam plik Erkal.txt, bedzie to /cmigrate Erkal
.

Po wykonaniu tego polecenia zostaniemy poinformowani, ze nalezy zmodyfikowac trigger ladujacy konfiguracje podczas logowania sie:

(skrypty): UWAGA: teraz wymagane sa nastepujace kroki:

(1) wejdz w 'Triggers' w gornym pasku
(2) odnajdz trigger, ktory laduje twoj config, prawdopodobnie bedzie mial w nazwie '[twoje imie]-login', lub cos podobnego
(3) zamien jego tresc z czegos w stylu scripts_load_config("_twoje_imie_") na scripts_load_v2_config("_twoje_imie_")
(4) po restarcie mudleta powinien zaladowac sie nowy config, stary plik imie.txt mozna wyrzucic

3.2 Rozpoczecie na swiezo, czyli zignorowanie obecnej konfiguracji i rozpoczecie nowej

Aby zainicjowac konfiguracje v2 nalezy skorzystac z aliasa /cinit [nazwa_pliku]
, przykladowo /cmigrate erkal
. Polecenie to utworzy plik erkal.json w katalogu profilu, gdzie bedzie trzymana konfiguracja.
Po tym poleceniu wciaz nalezy zmodyfikowac trigger ladujacy konfiguracje podczas logowania sie:

(1) wejdz w 'Triggers' w gornym pasku
(2) odnajdz trigger, ktory laduje twoj config, prawdopodobnie bedzie mial w nazwie '[twoje imie]-login', lub cos podobnego
(3) zamien jego tresc z czegos w stylu scripts_load_config("_twoje_imie_") na scripts_load_v2_config("_twoje_imie_")
(4) po restarcie mudleta powinien zaladowac sie nowy config, stary plik imie.txt mozna wyrzucic

4. Aliasy

/cfg
- pokaze link z odnosnikiem do tej strony
/cinit [imie_postaci] [imie_w_wolaczu]
- zainicjuje plik konfiguracyjny z danym imieniem i utworzy plik z rozszerzeniem json w katalogu profilu. Sprobuje stworzyc trigger ladujacy konfiguracje z imienie z wolacza. Jesli konfiguracja z danym imieniem istnieje alias nie bedzie mial zadnego efektu. Przyklad:
/cinit erkal Erkalu
/cmigrate [nazwa_pliku_imie]
- dokona migracji ze starego systemu do nowego. Wiecej w punkcie 3.2
/cget [wzorzec]
- pokaze ustawienie zmiennych pasujacych do wzorca
/cset [zmienna]=[wartosc]
- ustawi [zmienna] na [wartosc]. Dotyczy zmiennych z podstawowymi typami: string, number, boolean. Alias dokona walidacji wprowadzanej zmiennej. Przyklady:
- /cset herbs.many_to_int=50
- /cset herbs.pre_actions="wez sloiki ze swojego plecaka"
- /cset ateam.all_numbering=false
/cset [zmienna][index]=[wartosc]
- ustawi [index] w [zmienna] na [wartosc]. Dotyczy zmiennych list i map. Przyklady na podstawie wycinka konfiguracji z samej gory:
- /cset scripts.ui.cfg.footer_items[1]="glod"
  - zmieni "zmeczenie" na "glod", czyli lista bedzie miala postac
  ["glod", "forma", "mana", "pragnienie"]
- /cset scripts.ui.cfg.footer_items[5]="mana"
  - doda nowy element "mana" jako 5 element w liscie
  ["zmeczenie", "forma", "mana", "pragnienie", "mana"]
- /cset scripts.ui.cfg.footer_items[50]="mana"
  - brak efektu. Dodac mozemy tylko w istniejacy juz index (1-4), badz na jeden wyzej, czyli jako kolejny element, w tym przypadku byloby to 5.
- /cset scripts.ui.cfg.states_window_nav_printable_key_map["bron"]=" B R O N "
  - zmieni "BRON" na " B R O N " w kluczu "bron", czyli mapa bedzie miala postac
  ["bron": " B R O N ", "rozkaz": "ROZKAZ"]
- /cset scripts.ui.cfg.states_window_nav_printable_key_map["zaslona"]="ZASLONA"
  - doda nowy element w mapie o kluczu "zaslona" z wartoscia "ZASLONA", czyli mapa bedzie miala postac
  {"bron": "BRON", "rozkaz": "ROZKAZ", "zaslona": "ZASLONA"}
/cdel [zmienna][[index]]
- usunie [index] w [zmienna]. Dotyczy zmiennych list i map. Przyklady na podstawie wycinka konfiguracji z samej gory:
- /cdel scripts.ui.cfg.footer_items[2]
  - usunie "forma" z listy, czyli lista bedzie miala postac:
  ["zmeczenie", "mana", "pragnienie"]
- /cdel scripts.ui.cfg.footer_items[20]
  - brak efektu, lista nie ma 20 elementu, usunac mozna tylko elementy juz istniejace (1-4)
- /cdel scripts.ui.cfg.states_window_nav_printable_key_map["bron"]
  - usunie klucz "bron" z mapy, czyli mapa bedzie miala postac:
  ["rozkaz": "ROZKAZ"]
- /cdel scripts.ui.cfg.states_window_nav_printable_key_map["unkown"]
  - brak efektu, bo mapa nie ma klucza "unknown"
/cdel [zmienna] [wartosc]
- usunie [wartosc] ze [zmiennej]. Dotyczy tylko zmiennych list. Przyklady na podstawie wycinka konfiguracji z samej gory:
- /cdel scripts.ui.cfg.footer_items "pragnienie"
  - usunie "forma" z listy, czyli lista bedzie miala postac:
  ["zmeczenie", "forma", "mana"]
- /cdel scripts.ui.cfg.footer_items "unknown"
  - brak efektu, lista nie ma takiej wartosci
- /cdel scripts.ui.cfg.states_window_nav_printable_key_map "BRON"
  - brak efektu, ten alias nie dziala na mapach
/cadd [zmienna] [typ]
- doda zmienna konfiguracyjna o konkretnym typie. Zmienna ta nie jest w schemacie konfiguracji, takze uzytkownik jest w pelni odpowiedzialny za wykonywane operacje na tej zmiennej (z dwoma wykrzyknikami '!!'). Przyklady:
- /cadd skrypt_mapy.token string
  - doda zmienna konfiguracyjna o nazwie
  skrypt_mapy.token
  o typie string
- /cadd skrypt_moj.lista_wrogow list
  - doda zmienna konfiguracyjna o nazwie
  skrypt_moj.lista_wrogow
  o typie listy
/csave
- zapisze aktualna konfiguracje. Nie ma potrzeby uzywania tego polecenia, gdyz kazde
/cset ...
oraz
/cdel ...
zapisuje aktualizacje samoczynnie.
W dodatku, kazde z
/cset
oraz
/cdel
mozna wykonac z
!
(
/cset! ...
,
/cdel! ...
). Skrypty dokonaja wowczas zmiany i przeladowania odpowiednich modulow w celu natychmiastowego zaaplikowania zmiany