Insim

InSim

InSim jest protokołem, który pozwala zewnętrznemu programowi komunikować się z Live For Speed. Pozwala na tworzenie połączenia z grą oraz wysyłanie i odbieranie pakietów danych. Protokół InSim opisuje sposób formatowania każdego z tych pakietów, a każdy język programowania, który może utworzyć połączenie sieciowe i wysyłać i odbierać ciągi danych binarnych, może się z nim łączyć.

oficjalna dokumentacja znajduje się w pliku InSim.txt, znaleziony w folderze games doc. Składa się z pliku nagłówkowego C++, który zawiera definicję każdego pakietu, a także komentarze Scawena dotyczące tego, jak każdy z nich powinien być używany. Niniejsza dokumentacja jest przeznaczona jako pomocnicza dla tego pliku.

UDP vs TCP

InSim obsługuje zarówno połączenia UDP, jak i TCP. W trybie UDP można nawiązać tylko jedno połączenie, jednak do gry można nawiązać do ośmiu połączeń w TCP. Niezależnie od tego, czy jest podłączony w TCP, czy UDP, można określić oddzielne gniazdo UDP do odbierania aktualizacji pozycji samochodu, takie jak IS_MCI i IS_NLP.

przykład InSim

sposób tworzenia połączenia InSim jest oczywiście zależny od języka programowania, którego używasz, ale tutaj podejmujemy próbę udokumentowania procesu za pomocą przykładów z popularnego języka programowania Python. Jak wspomniano powyżej, każdy język zdolny do połączenia z gniazdem może być użyty do interfejsu z LFS, jednak zasada pozostaje taka sama niezależnie od tego.

Tworzenie połączenia

przede wszystkim musimy ustanowić połączenie gniazda z grą, w tym przypadku w TCP.

# Import Python's socket module.import socket# Initialise the socket in TCP mode. sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)# Connect to LFS.sock.connect(('localhost', 29999))

Inicjalizacja InSim

po nawiązaniu połączenia musimy zainicjować system InSim wysyłając pakiet IS_ISI. Zanim jednak to zrobimy, musimy najpierw intitailse InSim w samym LFS. Aby to zrobić, uruchom grę i wprowadź komendę czatu „/ insim 29999”. Użyty numer portu może być dowolnym poprawnym portem, ale 29999 zazwyczaj jest akceptowanym domyślnym.

oto definicja pakietu IS_ISI z InSim.txt.

struct IS_ISI // InSim Init - packet to initialise the InSim system{byteSize;// 44byteType;// ISP_ISIbyteReqI;// If non-zero LFS will send an IS_VER packetbyteZero;// 0wordUDPPort;// Port for UDP replies from LFS (0 to 65535)wordFlags;// Bit flags for options (see below)byteSp0;// 0bytePrefix;// Special host message prefix characterwordInterval;// Time in ms between NLP or MCI (0 = none)charAdmin;// Admin password (if set in LFS)charIName;// A short name for your program};

każdy pakiet InSim zaczyna się nagłówkiem, składającym się z 4 bajtów. Pierwszy bajt to Rozmiar pakietu, następnie typ pakietu z wyliczenia ISP_, a następnie ReqI (skrót od Request Id). Za każdym razem, gdy żądanie jest wysyłane do LFS, wartość ReqI musi być ustawiona na niezerową, przy czym LFS odpowie z tą samą wartością ustawioną w ReqI żądanego pakietu. Wreszcie czwarty bajt różni się w zależności od typu danego pakietu, który w tym przypadku jest pusty.

jak widać pakiet IS_ISI zawiera różne opcje i flagi, które są używane podczas inicjalizacji systemu InSim. Musimy spakować te dane do binarnego sformatowanego ciągu znaków, aby wysłać je do LFS.

# Import Python's struct module, which allows us to pack and unpack strings.import struct# Pack the IS_ISI data into a string.isi = struct.pack('BBBBHHBcH16s16s', 44, # Size 1, # Type 1, # ReqI 0, # Zero 0, # UDPPort 0, # Flags 0, # Sp0 ' ', # Prefix 0, # Interval 'password', # Admin 'MyProgram',) # IName# Send the string to InSimsock.send(isi)

odbieranie danych

po utworzeniu połączenia i zainicjowaniu InSim musimy ustawić pętlę odbioru pakietów. Ponieważ dane w trybie TCP są wysyłane jako stały strumień Danych, wiele pakietów może dotrzeć w jednym wywołaniu odbiorczym, a niektóre pakiety mogą dotrzeć niekompletne. Oznacza to, że musimy przechowywać wszystkie przychodzące dane w buforze, a następnie odczytywać każdy pakiet, gdy jesteśmy pewni, że jest kompletny.

# We use a string as the buffer.buffer = ''while True: # Receive up to 1024 bytes of data. data = sock.recv(1024) # If no data is received the connection has closed. if data: # Append received data onto the buffer. buffer += data # Loop through each completed packet in the buffer. The first byte of # each packet is the packet size, so check that the length of the # buffer is at least the size of the first packet. while len(buffer) > 0 and len(buffer) > ord(buffer): # Copy the packet from the buffer. packet = buffer)] # Remove the packet from the buffer. buffer = buffer):] # The packet is now complete! :) # doSomethingWithPacket(packet) else: break# Release the socket.sock.close()

rozpakowywanie pakietów

po otrzymaniu danych pakietu jako binarnego sformatowanego ciągu znaków, musimy rozpakować te dane do formatu, który jest dla nas przydatny. W poprzednim przykładzie, kiedy wysłaliśmy pakiet inicjalizacji IS_ISI, ustawiliśmy ReqI na niezerową, co oznacza, że LFS odpowiedział pakietem w wersji IS_VER, jednak nic z nim nie zrobiliśmy. Najpierw przyjrzyjmy się definicji pakietu IS_VER z InSim.txt.

struct IS_VER // VERsion{byteSize;// 20byteType;// ISP_VERSIONbyteReqI;// ReqI as received in the request packetbyteZero;charVersion;// LFS version, e.g. 0.3GcharProduct;// Product : DEMO or S1wordInSimVer;// InSim Version : increased when InSim packets change};

teraz spójrzmy, jak rozpakowalibyśmy te dane w Pythonie.

# Import Python's struct module.import struct# Unpack the binary formatted packet data into the values we need.size, type, reqi, zero, version, product, insimver = struct.unpack('BBBB8s6sH', packet)# Check the InSim version.if insimver != 4: print 'Invalid InSim version!' sock.close()

Keep Alive

aby utrzymać otwarte połączenie, LFS wyśle pakiet „keep alive” co około 30 sekund. Pakiet ten jest pakietem IS_TINY z podtypem TINY_NONE. Musimy odpowiadać na ten pakiet za każdym razem, gdy jest on odbierany, aby zapobiec przerwaniu połączenia z InSim.

# Some constants.ISP_TINY = 3TINY_NONE = 0# Check the packet type.if ord(packet) == ISP_TINY: # Unpack the packet data. tiny = struct.unpack('BBBB', packet) # Check the SubT. if tiny == TINY_NONE: # Send the keep alive packet back to LFS. sock.send(packet)

dalsze przykłady

możesz zobaczyć pełny przykład tego kodu, a także inne na stronie przykładów InSim.

Biblioteki InSim

oczywiście, jak mówi stare przysłowie, nie powinieneś próbować odkrywać koła na nowo (chyba że próbujesz dowiedzieć się więcej o kołach) i istnieje kilka dojrzałych bibliotek InSim dostępnych do użycia we własnym kodzie.

Insim Reference

oto próba odniesienia się do pełnego protokołu InSim.