Autor Wątek:  Maszynowe normy - wytyczne dla twórców  (Przeczytany 14303 razy)

0 użytkowników i 1 Gość przegląda ten wątek.

Offline REWIZOR

  • Administrator
  • Wiadomości: 3675
    • Zobacz profil
    • www.eu07.pl
  • Otrzymane polubienia: 7
Maszynowe normy - wytyczne dla twórców
« dnia: 26 Kwietnia 2010, 20:42:01 »
W celu podwyższenia standardu publikowanych dodatków do Symulatora Maszyna, z dniem 26.04.2010 wprowadza się w życie zbiór norm, które obowiązują przy tworzeniu modyfikacji:

I.   Wstęp:

Poniższe normy zostały stworzone w celu zapewnienia bezproblemowego działania i jak najwyższej jakości dodatków symulatora Maszyna. W tym celu muszą być one przestrzegane przez twórców i betatesterów, a dodatki niespełniające poniższych wymagań nie mogą zostać opublikowane.

II.   Postanowienia ogólne:

a)   Pliki z nowych paczek nie mogą nadpisywać starszych (wydanych wcześniej) plików. Nie należy modyfikować wcześniej wydanych plików na potrzeby własnego dodatku (np. nie wolno modyfikować plików jakiegoś semafora tylko dlatego, że tak potrzebuje do swojej trasy). W szczególnych przypadkach, gdy nadpisanie plików jest konieczne należy zapewnić kompatybilność wsteczną. Ponadto w pliku informacyjnym autor musi zawrzeć listę nadpisywanych plików.

b)   Nazwy plików i katalogów mogą być angielskie lub polskie, jednak stosowanie polskich znaków jest niedozwolone. Stosowanie w nazwach odstępów (spacji) również jest niedozwolone. Ponadto wszystkie nazwy plików i katalogów (a co za tym idzie również odnośników do nich we wpisach scn i modeli) muszą być napisane małymi literami (ma to szczególne znaczenie dla użytkowników linuxa).

c)   Każda paczka przeznaczona do publikacji powinna zawierać plik tekstowy o nazwie info.txt z opisem dodatku oraz innymi informacjami niezbędnymi do prawidłowego zainstalowania i używania dodatku oraz mieć strukturę katalogów zgodną z przyjętymi normami. Jeśli paczka zawiera nowy model (modele) taboru umieszczony w nowym katalogu w Dynamic, to powinna zawierać także odpowiednio uzupełniony plik TEXTURES.TXT. Jeśli paczka zawiera tylko tekstury, to w pliku informacyjnym należy umieścić odpowiednie wpisy tych tekstur do już istniejącego pliku TEXTURES.TXT. Szczegółowy opis zawartości plików TEXTURES.TXT znajduje się tu: http://eu07.rainsted.com/opis_tekstur.html
Ponadto w przypadku paczek z nowymi elementami taboru [modele i tekstury] należy w pliku informacyjnym zamieścić informację o konieczności użycia w starterze Rainsted przycisku "Sprawdź posiadany tabor" w zakładce "Tabor posiadany" po zainstalowaniu dodatku z paczki.

2.1   Każdy plik musi w nazwie zawierać informację o zawartości. Dla poszczególnych dodatków wymaga się następujące nazewnictwo:

a)    Dźwięki:
Nazwa pliku ma następujący format: [NrUseraNaForum]_RodzajDzwieku_wersja.wav np. 2193_runningnoise-en57_1.wav. Standardem formatu dźwięków używanych w symulatorze jest wav PCM 22kHz, 8 bit, mono. Wyjątkiem od tej reguły są dźwięki modulowane (szybkość odtwarzania takich dźwięków jest zależna od prędkości pojazdu). Do każdego dźwięku modulowanego muszą zostać podane zalecane parametry odtwarzania, gdyż nie wiadomo, czy użytkownik miał wcześniej dźwięk z paczki, czy z jakiegoś dodatku.

b)    Tekstury:
Tekstury tabliczek do sygnalizatorów muszą być wykonane za pomocą generatora dołączonego do paczki całościowej (autorem programu jest @Paul). Ponadto muszą znajdować się w katalogu "tabl", i posiadać nazwę zgodną z przyjętym już wzorem nazewnictwa tabliczek.

c)    Pliki używane przez scenerie (np. .inc semaforów):

- Pliki włączane do trasy, które mają służyć w wielu sceneriach, powinny mieć rozszerzenie INC. Pozostałe rozszerzenie SCM.

- W przypadku plików INC semaforów, tarcz i sygnalizatorów powtarzających, stosuje się ich następujące nazewnictwo:
Pierwsze dwie litery określają rodzaj sygnalizatora (SS – semafor świetlny, SK – semafor kształtowy, PS – sygnalizator powtarzający, MS – tarcza manewrowa świetlna, MK – tarcza manewrowa kształtowa, TS – tarcza ostrzegawcza świetlna, TK – tarcza ostrzegawcza kształtowa) – wyjątkiem są INC semaforów SBL. Następnie podana jest liczba komór (w przypadku sygnalizatorów świetlnych – UWAGA! Pas świetlny też się liczy jako komora) lub liczba ramion (w przypadku semaforów kształtowych). Sygnalizatory świetlne dalej mają w nazwie wyszczególnione kolejne komory (od góry, kolorami): p – pomarańczowe, c – czerwone, z – zielone, b – białe, n – niebieskie. Dalsze oznaczenie -z lub z- oznacza zielony pas świetlny. W przypadku -p lub p- będzie to pas pomarańczowy. Kolejne litery mówią, czy sygnalizator jest na słupie prostym, czy odchylonym (i w która stronę). Litera I oznacza słup prosty, litera Y odchylony, litery YN sygnalizator odchylony stojący z lewej strony toru. Na końcu nazwy inc sygnalizatora mogą znajdować się informacje o wskaźnikach umieszczonych na danym sygnalizatorze (np. W19, W20, W24). W przypadku kilku wskaźników należy umieścić je wg kolejności (np. W20W24).

d)    Tabor:

- Pliki charakterystyk powinny zostać wykonane poprawnie i starannie. Niedopuszczalne jest maskowanie błędów modelu wpisywaniem niewłaściwych wartości parametrów w pliku chk. Zabronione jest wykorzystanie istniejących charakterystyk do nowo powstających pojazdów (zakaz ten nie odnosi się do pojazdów tego samego typu bądź serii [np. różne wersje lokomotywy 303E]).

- Aby zapobiec nieprawidłowemu oświetleniu obiektów, modele tworzone w programach 3D powinny mieć zresetowane skalowanie obiektów.

III.   Struktura plików i katalogów

a)   W katalogu „Dynamic” tabor jest podzielony na poszczególne kraje (przewoźników PKP, CD, DB) oraz pojazdy drogowe (road). W katalogach przewoźników foldery z modelami należy nazywać oznaczeniami przewoźnika (EU07, Eaos) lub oznaczeniami fabrycznymi (111A, 2E) z dopiskiem kolejnego numeru wersji _vX. W celu uniknięcia niepotrzebnego dublowania plików dopuszcza się dodawanie tekstur taboru różnych przewoźników do jednego katalogu (w katalogu PKP/ST44_v1 mogą znajdować się tekstury zagranicznych przewoźników).

b)   W katalogu „Scenery” można tworzyć foldery zawierające pliki poszczególnych tras (nazwa folderu zgodna z nazwą trasy) oraz foldery zawierające pliki które mogą być wykorzystywane przez innych twórców (budynki, drzewa, semafory, wskaźniki itp.).

c)   Struktura katalogów „Models” i „Textures” powinna odpowiadać katalogowi „Scenery”. W przypadku modeli infrastruktury - nazwa modelu, tekstury i pliku inc powinna być identyczna. Jednocześnie nazwa ta powinna być jak najkrótsza.

d)   Elementy, które wykorzystywane będą tylko w danej scenerii (np. pliki układu torowego, eventy) umieszczamy w katalogu trasy.

e)   Elementy, które można będzie dowolnie wykorzystać w innych sceneriach (np. modele) należy umieścić w katalogu autora - katalog taki musi się znajdować w nadrzędnym folderze tematycznym (budynki, drzewa, infrastruktura przytorowa). Wykaz katalogów nadrzędnych oraz opis ich przeznaczenia znajduje się w załączniku "struktura.pdf".

IV.   Trasy:

a)   Zamiast tworzyć pojedynczy plik trasy, zaleca się rozdzielić ją na poszczególne moduły (tory, teren, budynki, eventy, składy itp.) zaincludowane w głównym pliku .scn. Ułatwi to dokonywanie modyfikacji wcześniej wydanych tras.

b) Szczególnie ważne jest nienadpisywanie już istniejących plików semaforów, wskaźników i sieci trakcyjnej, tak aby nie dopuścić do niewłaściwego działania pozostałych scenerii.

c) Tabliczki semaforów muszą posiadać nowe nazewnictwo. W paczce z trasa umieszczamy tylko te pliki tabliczek, których nie ma w paczce całościowej.  Przykład nazewnictwa:


Wygląd     Wpis do scenerii
AA
A2A-2
A/mA-m
A5A5
A5/mA5-m
A52/mA5-2m
A51/2/mA5-12m



V.   Modele:

1. Wytyczne dla modeli

a) Model w jak najwierniejszym stopniu odwzorowuje stan realny obiektu.

b) Wymagane jest, aby zaawansowane modele korzystały z techniki LoD.

c) Model nie posiada dziur i jest odpowiednio zmapowany, każdy widoczny element powinien być odpowiednio oteksturowany.

d) Model posiada jak najmniej (docelowo 0) zdegenerowanych trójkątów.

e) Model nie posiada płaszczyzn leżących jedna na drugiej, co powoduje nieciekawy efekt pasków/migotania.

f) Model powinien składać się z zamkniętej bryły a niewidoczne ściany modelu powinny być usunięte.

g) Model powinien składać się z jednego submodelu chyba, że ma możliwość zapalania świateł lub "Level of Details" (LOD).

h) O ile nie ma uzasadnionych powodów, powinny posiadać parametr diffuse ustawiony na 255 255 255, czyli na kolor biały. Ma to na celu prawidłowe oświetlanie modelu w scenerii.

i) Model powinien posiadać zresetowane: Transform, Scale i Pivot w punkcie [0,0,0].

2. Pliki .inc powiązane z modelami powinny zawierać:

a) Komendę "//script size x y z" opisującą wymiary modelu.

b) Opis koordynacji modelu wzgl. "helpera" (np. "//wzrastająca oś X przód budynku") .

c) Przy zmiennej teksturze (tzw. replaceableskin) w pliku *.inc jako komentarz musi się znaleźć informacja o ścieżkach dostępu do tekstur dostarczanych przez autora modelu.

d) Obrót modelu (rotate): przy znakach i wskaźnikach we wszystkich trzech osiach, przy reszcie tylko w osi Z.

e) Opcjonalnie informacja o autorze modelu i zdjęć na tekstury.

f) Przy modelu posiadającym oświetlenie (wiaty, latarnie) submodele oświetlenia powinny mieć wpis w t3d name: light_on00/light_off00, natomiast w pliku inc w linijce dostępu do modelu umieścić należy formułę "lights 3". Powoduje to automatyczne załączanie się świateł po zmroku.

3. Sprzęgi i wężyki

Sprzęg: punkt łączenia sprzęgu powinien znajdować się na wysokości 1050 mm od główki szyny i oddalony 380 mm od czoła zderzaka w osi pojazdu, tak jak jest to przedstawione na schemacie w załączniku.
Zderzaki: Powinny znajdować się na wysokości 1050 mm od główki szyny oddalone od siebie o 1750 mm. Długość samego bufora winna wynosić 620 mm.
Węże pneumatyki: Punkty łączenia węży powinny być na wysokości 500 mm od główki szyny równo z czołem zderzaka, a odległości od osi pojazdu w przypadku czerwonych to 445 mm a żółtych 625 mm.
W załącznikach również gotowe pliki .max sprzęgów autorstwa @FLOYDa.


VI.   Inne:

1.

a) Sygnały na sygnalizatorach wywołujemy zdarzeniem adekwatnym do żądanego efektu (np. aby wyświetlić sygnał S5 należy wywołać event nazwasemafora_s5). Aby podświetlić wskaźnik znajdujący się na semaforze, należy ponadto wywołać event adekwatny do wskaźnika (np. jeśli chcemy na semaforze podświetlić wskaźnik W24, wywołujemy zdarzenie nazwasemafora_W24).
Jeśli dany sygnalizator świetlny ma stary układ komór (charakteryzujący się znajdowaniem się komory światła zielonego w środku lub w dolnej części głowicy) i układ zezwala na wyświetlenie starego sygnału, można to uczynić wywołując następujące eventy:

- Aby wyświetlić sygnał na semaforze "Wolna droga ze zmniejszoną szybkością" lub "Wolna droga ze zmniejszoną szybkością. Następny semafor wskazuje sygnał zezwalający na jazdę." (dwa światła zielone świecące w jednym ciągu), należy wywołać event nazwasemafora_sv40.

- Aby wyświetlić sygnał na semaforze "Wolna droga. Następny semafor wskazuje sygnał zezwalający na jazdę ze zmniejszoną szybkością." (licząc od góry: pomarańczowe + zielone świecące się jednym ciągiem – odpowiednik obecnego S4) należy wywołać event nazwasemafora_S4old.

- Aby wyświetlić sygnał na tarczy ostrzegawczej "Semafor wskazuje sygnał "Wjazd ze zmniejszoną szybkością. Następny semafor wskazuje sygnał "Stój" lub sygnał "Wolna droga ze zmniejszoną szybkością. Następny semafor wskazuje sygnał zezwalający na jazdę""" (licząc od góry: pomarańczowe + zielone świecące się jednym ciągiem – odpowiednik obecnego os4) należy wywołać event nazwatarczyostrz_os4old.

- Aby wyświetlić sygnał na sygnalizatorze powtarzającym Sp "Semafor wskazuje sygnał zezwalający na jazdę ze zmniejszoną szybkością". (licząc od góry: pomarańczowe + białe + zielone świecące jednym ciągiem – odpowiednik obecnego sp4) należy wywołać event nazwasp_sp4old.

b) Przy wysyłaniu wątków w dziale Test dodatków w celu przetestowania modelu (np. wagonu) wymagane jest, aby zamieścić informację o wszystkich obiektach, przy tworzeniu których zastosowano technikę LOD.

c) Tekstury powinny być zapisane wyłącznie w globalnym formacie paczki (DDS oraz TGA). Przy tworzeniu tekstury należy wykorzystywać bezstratny format zapisu, np. TGA, a dopiero gotową teksturę konwertować do DDS wg instrukcji. Tekstury symulatora w formacie TGA dla twórców, dostępne są pod tym linkiem. Nigdy nie należy konwertować tekstury DDS do formatu TGA.

d) Tekstury nie powinny zawierać kanału alfa, jeśli nie posiadają przeźroczystych elementów (tekstury dróg, rzek czy podsypek nie wyświetlają się, jeśli mają kanał alfa).

e) Jeśli chcemy użyć w modelu pojazdu tekstur wykorzystywanych przez inny tabor (np. kół, wężyków, sprzęgów, pantografów, itp.), należy sprawdzić czy nie znajdują się w folderze textures/tabor (jeśli tak, to z nich należy korzystać). Unikniemy w ten sposób tworzenia duplikatów tekstur. Tworzenia duplikatów tekstur należy również unikać w przypadku innych obiektów, wykorzystywanych w sceneriach.

f) Należy unikać używania jawnych rozszerzeń plików.

g) Przy wysyłaniu wątków w dziale Test dodatków wszelkiego rodzaju tekstur i modeli wymagane jest zamieszczanie screenów.

2. Aby stopniowo zautomatyzować proces instalacji dodatków do symulatora, należy dodatkowo wykonać plik instalacyjny do instalatora Rainsted. UWAGA! Do odwołania zapis ten dotyczy wyłącznie tekstur taboru. Jeżeli pojawią się instrukcje tworzenia skryptu do szerzej grupy dodatków, zapis będzie obowiązywał również je.

a) Zasady publikacji dodatków opisane są tu: http://eu07.pl/forum/index.php/topic,25406.0.html
b) Instrukcja tworzenia pliku instalacyjnego tekstur taboru znajduje się tu: http://eu07.pl/forum/index.php/topic,23964.0.html
c) W razie wątpliwości jak się za to zabrać - proszę śmiało pytać w swoim wątku podczas testów w dziale Test dodatków.


Stan na dzień: 14.04.2011.

Jeśli jakiś punkt jest niezrozumiały, prosimy o poszukanie informacji na temat danego zagadnienia i w ostateczności – gdy nie znaleziono wyjaśnień – wysłanie wątku na forum z prośbą o dokładniejszy opis zagadnienia.

22.06.2010 – aktualizacja punktu II, c.
23.11.2010 – aktualizacja punktu II, b.
14.04.2011 – aktualizacja punktu VI, dodane podpunkty c, d, e.
09.02.2012 – aktualizacja punktów II, c oraz V, b.
08.10.2012 – aktualizacja punktów III, c,d; V, 1 - 3; VI, f.
07.07.2013 – wykreślenie podpunktu f w V dziale, punkt 1.
18.08.2013 - zaktualizowano strukturę katalogów (patrz załącznik).
20.12.2013 - aktualizacja punktu VI, c.
13.06.2014 - aktualizacja w punkcie VI, dodano podpunkt 2.
19.10.2015 - aktualizacja w punkcie III, wykreślono podpunkt e.
18.12.2015 - aktualizacja w punkcie VI, dodano podpunkt g, gdyż wielu autorów nie miało w zwyczaju dodawania screenów.
« Ostatnia zmiana: 18 Grudnia 2015, 15:25:11 wysłana przez Sawi »
Pozdrawiam