Licencjacka Pracownia Oprogramowania Instytut Informatyki Uniwersytetu Wrocławskiego Jakub Kowalski, Andrzej Pilarczyk, Marek Kembrowski, Bartłomiej Gałkowski Dokumentacja projektu QUAIKE Instrukcja obsługi aplikacji klienta 23 czerwca 2009 Wersja 0.45
QUAIKE. Instrukcja obsługi aplikacji klienta Tabela 1. Historia zmian w dokumencie Lp. Data Nr wersji Autor Zmiana 1. 2009-06-18 ε Jakub Kowalski Utworzenie dokumentu 2. 2009-06-18 0.1 Jakub Kowalski Podstawowe informacje i podstawy pracy 3. 2009-06-19 0.2 Jakub Kowalski Zaawansowane zagadnienia 4. 2009-06-19 0.3 Jakub Kowalski Wstępna korekta 5. 2009-06-21 0.4 Andrzej Pilarczyk Dodanie grafik i korekta 6. 2009-06-21 0.45 Jakub Kowalski Korekta Spis treści 1. Podstawowe informacje................................... 3 1.1. Instalacja aplikacji klienta................................ 3 2. Podstawy pracy z aplikacją klienta........................... 3 2.1. Interfejs aplikacji..................................... 3 2.1.1. Polecenia menu i skróty............................. 3 2.2. Tworzenie lokalnej rozgrywki.............................. 4 2.3. Łączenie z serwerem................................... 5 2.4. Tworzenie rozgrywki na serwerze............................ 6 2.5. Oglądanie rozgrywek................................... 6 2.6. Zarządzanie kontem użytkownika............................ 6 2.7. Wyświetlanie rozgrywki................................. 8 2.7.1. Wyświetlanie parametrów bota........................ 8 3. Zaawansowane zagadnienia pracy z aplikacją klienta................ 10 3.1. Zapisywanie rozgrywek................................. 10 3.2. Odtwarzanie zapisanych rozgrywek........................... 10 3.2.1. Opcje odtwarzania............................... 10 Literatura............................................. 11 2
1. Podstawowe informacje 1. Podstawowe informacje Aplikacja klienta Quaike została napisana aby umożliwić użytkownikom oglądanie, zapisywanie i odtwarzanie rozgrywek w systemie Quaike. Za jej pomocą można również publikować boty na serwerach gry. 1.1. Instalacja aplikacji klienta Aplikacja klienta znajduje się w pakiecie instalacyjnym programu Quaike. Proces instalacyjny sprowadza się do postępowania zgodnie z pojawiającymi się w trakcie instalacji wskazówkami. 2. Podstawy pracy z aplikacją klienta 2.1. Interfejs aplikacji Interfejs aplikacji klienta (rys. 1) składa się z kilku części: 1. Menu zawiera podstawowe komendy potrzebne do pracy z edytorem. 2. Pole gry w tym miejscu wyświetlany jest aktualnie oglądany pojedynek. 3. Widok bota wyświetlane są tutaj parametry biorących udział w pojedynku botów. 4. Opcje odtwarzania pozwalają na odtwarzanie zapisanej rozgrywki. 2.1.1. Polecenia menu i skróty Poniżej opisane są polecenia dostępne w menu Game: Start Local Game ([Ctrl]+[L]) tworzy nową rozgrywkę lokalną Start Online Game ([Ctrl]+[O]) tworzy nową rozgrywkę na serwerze Watch Game ([Ctrl]+[W]) umożliwia oglądanie dowolnej potyczki rozgrywanej aktualnie na serwerze Account Management ([Ctrl]+[A]) pozwala na opublikowanie botów na serwerze i pobranie ich na dysk Connect ([Ctrl]+[C]) łączy z wybranym serwerem, a także pozwala zarejestrować i wyrejestrować użytkownika Play Sound ([Ctrl+[P]) włącza/wyłącza dźwięki w grze Show FoV ([Ctrl+[V]) włącza/wyłącza wyświetlanie pola widzenia botów Poniżej opisane są polecenia dostępne w menu Replay: Save ([Ctrl]+[S]) zapisuje na dysk powtórkę właśnie zakończonego pojedynku Load ([Ctrl]+[D]) odtwarza zapisaną powtórkę z dysku W nawiasach podane są skróty klawiaturowe odpowiadające poleceniom możliwym do wyboru z menu. ([X]+[Y]) oznacza, że należy wcisnąć na klawiaturze klawisz [X], a następnie nie puszczając klawisza [X] wciśnąć klawisz [Y]. 3
QUAIKE. Instrukcja obsługi aplikacji klienta Rys. 1. Interfejs aplikacji klienta Quaike 2.2. Tworzenie lokalnej rozgrywki Aby utworzyć nową rozgrywkę lokalną nie jest wymagane podłączenie do serwera. W oknie, które pokaże się przy próbie utworzenia takiej rozgrywki (rys. 2) możemy ustawić wymienione poniżej opcje. - Mapę, na której będzie odbywała się gra. Aby mapa była dostępna musi znajdować się w katalogu Maps w katalogu z grą. - Typ rozgrywki. Zaznaczenie pola Cross Map Mode spowoduje, że będą dostępne wszystkie boty, które nie zostały zdefiniowane dla konkretnej mapy. W przeciwnym przypadku pojedynek będzie mógł być toczony jedynie między botami zdefiniowanymi dla wybranej mapy lub nie posiadającymi przypisanej mapy. - Wybór botów. Aby bot był dostępny musi spełniać warunki zależne od wybranego trybu gry. W katalogu Bots w katalogu z grą musi się znajdować plik o rozszerzeniu dll ze skompilowanym botem. - Warunki zwycięstwa. Pojedynek może się toczyć do zdobycia odpowiedniej liczby punktów lub przez określoną ilość tur. Co najmniej jedna z opcji definiujęcych metodę zwycięstwa musi być zaznaczona aby rozpoczęcie rozgrywki było możliwe. 4
2.3 Łączenie z serwerem Rys. 2. Okno tworzenia nowej rozgrywki lokalnej Rys. 3. Pasek aplikacji po zarejestrowaniu 2.3. Łączenie z serwerem Podczas próby połączenia z serwerem pokazuje się okno (rys. 4), w którym możemy wykonać kilka czynności. 1. Połączyć się z serwerem. W tym celu należy wpisać w pole Insert Server IP Adress adres serwera Quaike-a, z którym chcemy się połączyć i wcisnąć przycisk Connect. 2. Utworzyć nowe konto. Jeśli użytkownik jest podłączony do serwera, po zaznaczeniu pola Create New ma możliwość utworzenia nowego konta. W odpowiednie pola należy wpisać identyfikator (ang. login), hasło (ang. password) oraz kontaktowy adres e-mail, a następnie kliknąć przycisk Create. 3. Jeśli użytkownik posiada konto na serwerze, to po wpisaniu identyfikatora i hasła oraz przyciśnięciu przycisku LogIn zostanie zarejestrowany, co pozwoli mu na pełne wykorzystanie możliwości programu Quaike. Po zarejestrowaniu danego użytkownika, informacja o tym będzie widoczna na pasku programu (rys. 3). Jeśli użytkownik jest podłączony do serwera, to korzystając z przycisku Disconnect może zamknąć to połączenie. Gdy użytkownik był zarejestrowany na serwerze to równocześnie zostanie wyrejestrowany. 5
QUAIKE. Instrukcja obsługi aplikacji klienta Rys. 4. Okno łączenia z serwerem. Od lewej: przed połączeniem; w trakcie zakładania konta; przed zarejestrowaniem Zaznaczenie opcji Remember Me pozwoli aplikacji na zapamiętanie używanego adresu serwera, identyfikatora oraz hasła i nie będzie potrzeby wpisywania tych danych podczas kolejnego łączenia. 2.4. Tworzenie rozgrywki na serwerze Aby utworzyć rozgrywkę na serwerze trzeba być do niego podłączonym. Okno pojawiające się podczas tworzenia rozgrywki online (rys. 5) jest podobne do tego, które wyświetla się przy zakładaniu nowej gry lokalnej (rys. 2). W przypadku rozgrywki online dostępne są wszystkie mapy i boty, które znajdują się na tym serwerze gry, z którym aplikacja jest połączona. 2.5. Oglądanie rozgrywek Aby oglądać aktualnie rozgrywane pojedynki innych użytkowników należy połączyć się z serwerem. W oknie wyboru rozgrywki (rys. 6) znajdują się wszystkie aktualnie prowadzone na serwerze pojedynki. Widać między jakimi botami się toczy każdy z pojedynków oraz na jakiej mapie jest rozgrywany. Wybór jednego z nich spowoduje pobranie go z serwera i odtworzenie w aplikacji. 2.6. Zarządzanie kontem użytkownika Aby użytkownik mógł zarządzać swoim kontem musi być zarejestrowany. Do zarządzania kontem służy okno pokazane na rysunku 7. Za pomocą tego okna użytkownik może opublikować swojego bota na serwerze. Aby to zrobić należy wpisać opis bota w dolnym polu, a następnie kliknąć Upload i wybrać plik z kodem źródłowym bota. Istnieje również możliwość pobrania na dysk swoich botów, które 6
2.6 Zarządzanie kontem użytkownika Rys. 5. Okno tworzenia nowej rozgrywki na serwerze Rys. 6. Okno wyboru oglądanej rozgrywki 7
QUAIKE. Instrukcja obsługi aplikacji klienta Rys. 7. Okno zarządzania kontem użytkownika znajdują się na serwerze. Boty zarejestrowanego użytkownika są wyświetlone w górnym polu. Dwukrotne kliknięcie lewym przyciskiem myszy na którymś z wymienionych botów pozwoli zapisać przechowywany na serwerze kod źródłowy tego bota na dysku. 2.7. Wyświetlanie rozgrywki W trakcie wyświetlania rozgrywki jej przebieg będzie wizualizowany w polu gry (rys. 1). Powyżej wyświetlanej rozgrywki znajdują się informacje o aktualnej rundzie gry oraz mapie, na której toczy się oglądany pojedynek. Istnieje możliwość włączenia lub wyłączenia dźwięku oraz pola widzenia botów. 2.7.1. Wyświetlanie parametrów bota W trakcie rozgrywki użytkownik na bieżąco widzi parametry obu botów. Są one wyświetlane po obu stronach pola gry (rys. 1). Po lewej stronie są to parametry bota wyświetlanego na mapie w niebieskim pancerzu, po prawej zaś w zielonym. Parametry bota, które są wyświetlane przedstawia rysunek 8 i są one opisane poniżej. 1. Rysunek stanowiący portret bota. 2. Nazwa bota, kolor tła identyfikuje bota na polu gry. 3. Liczba zdobytych fragów. 4. Liczba punktów życia. 5. Liczba punktów pancerza. 6. Oznaczenie broni, które bot posiada. 8
2.7 Wyświetlanie rozgrywki Rys. 8. Wyświetlane parametry bota 9
QUAIKE. Instrukcja obsługi aplikacji klienta Rys. 9. Opcje odtwarzania powtórki 7. Oznaczenie broni, których bot nie posiada. 8. Wyróżniona aktualnie trzymana przez bota broń. 9. Pozostała ilość amunicji dla każdej broni. Jeśli bot posiada quada [1], to pod wykazem broni pojawia się rysunek quada wraz z informacją o pozostałym czasie jego działania. 3. Zaawansowane zagadnienia pracy z aplikacją klienta Aby móc dokładnie analizować przebieg rozgrywki użytkownik ma możliwość zapisania jej powtórki na dysk, po czym dowolnego jej odtwarzania. Plik zapisu rozgrywki ma rozszerzenie sav. 3.1. Zapisywanie rozgrywek Po zakończeniu rozgrywki, czyli w momencie gdy na polu gry pojawi się napis ją podsumowujący, można zapisać na dysk powtórkę korzystając z opcji Replay Save. 3.2. Odtwarzanie zapisanych rozgrywek Aby odtworzyć powtórkę pojedynku należy otworzyć odpowiedni plik o rozszerzeniu sav z dysku za pomocą polecenia Replay Load. Rozgrywka zostanie załadowana i automatycznie rozpocznie się jej odtwarzanie. 3.2.1. Opcje odtwarzania Aby ułatwić analizę pojedynków podczas odtwarzania powtórki są dostępne dodatkowe opcje opisane poniżej. Przyciski służące do sterowania tymi opcjami są wyświetlane pod polem gry (rys. 9). 1. Pokazuje na jakim etapie znajduje się odtwarzanie rozgrywki. Kliknięcie na pasku pozwala przenieść się do wskazanej chwili. 2. ([Spacja]) Zatrzymuje odtwarzanie rozgrywki lub ponownie uruchamia odtwarzanie od chwili, w której była zatrzymana. 10
Literatura 3. ([Enter]) Kończy odtwarzanie rozgrywki. 4. ([Home]) Przechodzi do początku rozgrywki. 5. ([Z]) Cofa oglądaną rozgrywkę o 10 tur. 6. ([C]) Cofa oglądaną rozgrywkę o jedną turę. 7. ([V]) Przechodzi do przodu o jedną turę. 8. ([X]) Przechodzi do przodu o 10 tur. 9. ([End]) Przechodzi na koniec rozgrywki, do ekranu wyniku. 10. Ustala szybkość odtwarzania powtórki. Klawisz [N] zwiększa szybkość, zaś klawisz [M] ją zmniejsza. ([Y]) oznacza, że naciśnięcie klawisza [Y] na klawiaturze spowoduje wywołanie danej opcji. Literatura 1. Jakub Kowalski, Andrzej Pilarczyk, Marek Kembrowski, Bartłomiej Gałkowski, Dokumentacja projektu QUAIKE. Słownik. Wrocław, LPO IIUWr 2009. 11