XCOM 2: szybki start z SDK Spis treści Introduction... 1 Getting Started... 2 Install the XCOM2 SDK on Steam... 2 Install the 2013 Visual Studio Isolated Shell Redistributable... 2 Launch Modbuddy for XCOM2... 2 First Time Setup... 3 Start Page... 4 New Project... 4 The Mod Pipeline... 4 Mod Components... 4 Building... 5 Testing... 6 Publishing... 7 Publishing to Steam Workshop... 7 Publishing Stand-alone... 9 Wstęp W skład XCOM 2 SDK do tworzenia modów wchodzą trzy główne części: 1. Modbuddy Firaxis z rozwinięciami XCOM 2. 2. 64-bitowa wersja UnrealEd do XCOM 2. a. Ten plik wykonawczy może też obsługiwać polecenia cmdlets UE3, takie jak kompilator albo tzw. cooker skryptu. 3. Zawartość podstawowa XCOM 2. a. Odblokowane mapy i pakiety. b. Kod źródłowy skryptu Unreal. Ten krótki przewodnik koncentruje się na uruchomieniu Modbuddy i pokazaniu, jak można go użyć do otwarcia oraz opublikowania przykładowego modu.
Pierwsze kroki Pierwszy krok do stworzenia modu XCOM 2 to uruchomienie Modbuddy. Instalacja XCOM 2 SDK na Steam XCOM 2 SDK jest dostępne w Steam w zakładce Biblioteka->Narzędzia. Przejdź do Narzędzi: Znajdź XCOM 2 SDK pod nazwą XCOM 2 SDK i wybierz zainstaluj z menu otwieranego prawym przyciskiem myszy. Instalacja 2013 Visual Studio Isolated Shell Redistributable Modbuddy do XCOM 2, przypominający poprzednie wersje Modbuddy do Civilization, wykorzystuje Visual Studio Isolated Shell, by dostarczyć IDE do modowania. Zainstalowany program znajduje się w folderze instalacyjnym gry, w Binaries\Redist. Przykładowo: \SteamLibrary\steamapps\common\XCOM 2 SDK\Binaries\Redist. Uruchamianie Modbuddy do XCOM 2 Wybierz graj w XCOM 2 SDK na Steam, żeby uruchomić Modbuddy do XCOM 2. Pierwsze wczytanie IDE może potrwać dłuższą chwilę.
Konfiguracja przy pierwszym uruchomieniu Po pierwszym uruchomieniu Modbuddy użytkownicy powinni dostosować ustawienia ogólne IDE związane z miejscem instalacji XCOM 2. Wybierz Tools->Options, a następnie przejdź na dół menu opcji, jak pokazano poniżej. Upewnij się, że podane ścieżki są prawidłowe. Ścieżka instalacji XCOM 2 Ta ścieżka powinna prowadzić do plików GRY, z końcówką XComGame. Ścieżka użytkownika XCOM 2 Ta ścieżka powinna prowadzić do plików SDK, z końcówką XComGame. Domyślnie informacje o budowaniu w Visual Studio Isolated Shell są ustawione na minimum. Aby otrzymywać więcej informacji z budowania i kompilacji skryptu, musisz zmienić to ustawienie. Wybierz Tools -> Options -> Projects and Solutions -> Build and Run. Zmień opcje verbosity na Normal, a następnie kliknij OK.
Strona startowa Po pierwszym uruchomieniu IDE użytkownik trafi na stronę startową, na której znajdują się opcje tworzenia nowych projektów modów, otwierania istniejącego projektu modu i wyświetlenia listy niedawno otwieranych projektów modów. W tym poradniku szybkiego startu stworzymy nowy projekt modu, więc teraz wybierz New Mod. Nowy projekt Po wybraniu opcji New Mod wyświetli się okno widoczne po prawej stronie. Domyślnie są w nim widoczne zainstalowane szablony projektów XCOM 2, które można wykorzystać do stworzenia nowego projektu. W tym przewodniku wybierzemy szablon projektu ExampleWeapon. To projekt przykładowy, zawierający cały kod skryptu, pliki konfiguracyjne, pliki lokalizacyjne i pakiety zawartości potrzebne, by dodać do gry nową broń. Wybierz ExampleWeapon i kliknij OK. Modowanie Stworzyliśmy już projekt modu, możemy więc zapoznać się z elementami, które na niego się składają. Oprócz tego stworzymy, przetestujemy i opublikujemy nasz mod. Elementy modu Mody XCOM 2 składają się z wielu rodzajów danych, których połączenie wprowadza zmiany w podstawowej grze. Kod skryptu: Kod skryptu to najważniejszy rodzaj zawartości modu. W naszym przykładowym modzie broni kod skryptu określa szablon danych, czyli dane gry opisujące działanie broni. Jakie zadaje uszkodzenia? Z jakich może korzystać ulepszeń? Jakiego wymaga poziomu technologicznego? Trzeba ją skonstruować czy jest dostępna od początku? Ile będzie kosztować? Szablony danych to zaledwie ułamek tego, co można dodać za pomocą skryptu. Kod skryptu, jeżeli zastąpi oryginalny skrypt gry, może posłużyć do radykalnej przemiany XCOM.
Pakiety zawartości Unreal: Pakiety zawartości Unreal mogą być plikami UPK albo MAP. W tych plikach znajduje się zawartość gry: siatka poligonowa, tekstury, animacje, dźwięki, modele fizyki, archetypy itp. W naszym przykładowym modzie broni znajduje się jeden pakiet o nazwie WP_ModExampleWeapon_CV, który określa, jak nowa broń będzie wyglądać, brzmieć i strzelać; z jakiej amunicji będzie korzystać, jak będzie upadać, jeśli zostanie upuszczona itd. Ten pakiet jest powiązany z powyższym szablonem danych. Pakiety zawartości są tworzone za pomocą UnrealEd, o którym opowiemy później. Pliki konfiguracyjne: Pliki konfiguracyjne, inaczej INI, służą do określania ustawień i domyślnych wartości gry. Są wygodne w użyciu, ponieważ wprowadzanie w nich zmian nie wymaga ponownej kompilacji, a system przetwarzania pliku konfiguracyjnego UE3 umożliwia zastępowanie poszczególnych ustawień konfiguracyjnych bez ingerowania w pozostałe. Ta użyteczna cecha jest dobrze widoczna w naszym przykładowym modzie broni, gdzie XComEditor i XComEngine (pliki konfiguracyjne z dużą ilością ustawień) dodają po prostu pakiet naszego modu do listy informującej silnik o zmianach. Dzięki temu może istnieć jednocześnie wiele modów edytujących te same pliki konfiguracyjne... przynajmniej w większości przypadków. Pliki lokalizacyjne: Pliki lokalizacyjne to zwykle po prostu pliki konfiguracyjne o specjalnym przeznaczeniu: mają zapewnić graczom odpowiednie teksty w grze. W naszym przykładowym modzie broni znajdują się linijki tekstu po angielsku (INT), dzięki czemu można prawidłowo wypełnić wyświetlane w grze pola nazwy itp. Readme.txt i ModPreview.jpg: Obraz ModPreview posłuży do pokazania modu w Steam Workshop, a readme.txt dostarczy instrukcji albo innych informacji związanych z modem. Budowanie Po stworzeniu zawartości modu i przygotowaniu go do testów, czas zbudować mod w postaci, którą może wczytać gra. Żeby to zrobić, użyj znajdującej się na pasku zadań opcji Build->Build Solution.
Okno efektów: Po wybraniu opcji Build Solution IDE wyświetla postępy budowania w oknie efektów. Podczas tego procesu Modbuddy stworzy pliki niezbędne do przetestowania i wczytania modu. Część tego procesu to kompilacja kodu skryptu. Sprawdź wyniki kompilacji skryptu, żeby zobaczyć kody sukcesów i błędów. Testowanie Podczas tworzenia modu warto przetestować go lokalnie, zanim udostępnimy go w Steam Workshop. XCOM 2 SDK posiada do tego odpowiedni mechanizm w menu DEBUG. Kliknij w menu opcję Start Debugging, żeby rozpocząć testowanie. Mod zostanie zbudowany, a następnie wystartuje program uruchamiający XCOM 2. Wybierz mod ExampleWeapon i kliknij Graj. Program uruchamiający wyliczy wszystkie mody subskrybowane albo zainstalowane przez użytkownika. W polu opisu lokalnych albo samodzielnych modów będzie widoczna ich ścieżka relatywna. Wybór opcji Graj uruchomi XCOM 2 z włączonym modem ExampleWeapon. Sprawdź, czy mod poprawnie działa w grze. Mod ExampleWeapon wprowadza nową broń, która będzie dostępna od początku gry, więc sprawdzimy go, uruchamiając kampanię dla jednego gracza i wyposażając żołnierza w nową broń. Oto kod skryptu z szablonu określającego właściwości, które chcemy nadać broni:
A oto mod działający w XCOM 2: Skoro już wiemy, że mod działa zgodnie z założeniami, możemy go opublikować. Publikowanie Mody można publikować w Steam Workshop albo rozpowszechniać jako samodzielne pakiety. Publikowanie w Steam Workshop Żeby opublikować zawartość w Steam Workshop, wejdź najpierw na stronę Steam Workshop i sprawdź, czy wyrażasz na swoim koncie zgodę na warunki umowy licencyjnej. Możesz to zrobić wybierając Społeczność->Warsztat->Twoje pliki->zobacz umowę.
Następnie wybierz w menu opcję Tools->Publish dostępną w XCOM 2 IDE. To rozpocznie proces zamieszczania zawartości użytkownika w Steam Workshop. Informacje o tworzeniu elementów Steam Workshop i procesie zamieszczania będą wyświetlane w oknie efektów IDE. Wejdź na swoją stronę elementów użytkownika Steam Workshop, żeby zobaczyć zamieszczony mod. Zauważ, że po zamieszczeniu modu, jego widoczność będzie ustawiona na ukryty. Żeby udostępnić go publicznie, musisz zmienić jego widoczność.
Publikowanie samodzielnego elementu Publikowanie samodzielnych modów wiąże się z przygotowaniem plików do dystrybucji poza Steam. Żeby opublikować samodzielny mod, znajdź podstawowy katalog XCOM 2 SDK, a w nim folder XComGame\Mods. Zwykle znajduje się on w bibliotece Steam albo w folderze instalacyjnym Steam. Przykład widać po prawej stronie. Spakuj folder ExampleWeapon do redystrybucji. Użytkownik pragnący zainstalować mod na swoim komputerze musi po prostu wypakować ExampleWeapon w XComGame\Mods w folderze instalacyjnym XCOM 2.