InSim

InSim

InSim este un protocol care permite unui program extern să comunice cu Live for Speed. Vă permite să creați o conexiune socket cu jocul și să trimiteți și să primiți pachete de date. Protocolul InSim descrie modul în care fiecare dintre aceste pachete este formatat și orice limbaj de programare care poate crea o conexiune la rețea și trimite și primi șiruri de date binare poate interfața cu acesta.

documentația oficială este inclusă în fișierul InSim.txt, găsit în folderul Jocuri doc. Se compune dintr-un fișier antet C++ care conține definiția pentru fiecare pachet, precum și comentarii de la Scawen cu privire la modul în care fiecare ar trebui să fie utilizat. Documentația de aici este destinată ca un accesoriu la acest fișier.

UDP vs TCP

InSim acceptă atât conexiuni UDP și TCP. În modul UDP se poate face o singură conexiune, cu toate acestea până la opt conexiuni pot fi făcute la joc în TCP. Indiferent dacă este conectat în TCP sau UDP, este posibil să specificați un soclu UDP separat pentru primirea actualizărilor poziției mașinii, cum ar fi IS_MCI și IS_NLP.

exemplu InSim

modul în care creați o conexiune InSim depinde desigur de limbajul de programare pe care îl utilizați, dar aici facem o încercare de a documenta procesul cu câteva exemple din popularul limbaj de programare Python. După cum sa menționat mai sus, orice limbă capabilă să realizeze o conexiune socket poate fi utilizată pentru a interfața cu LFS, totuși principiul rămâne același indiferent.

crearea unei conexiuni

în primul rând trebuie să stabilim o conexiune socket cu jocul, în acest caz în 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))

inițializarea InSim

după stabilirea conexiunii trebuie să inițializăm sistemul InSim prin trimiterea pachetului IS_ISI. Înainte de a putea face acest lucru, totuși, trebuie mai întâi să intitailse InSim în cadrul LFS în sine. Pentru a face acest lucru, începeți jocul și introduceți comanda de chat „/insim 29999”. Numărul portului utilizat poate fi orice port valid, dar 29999 tinde în general să fie implicit acceptat.

iată definiția pachetului IS_ISI de la 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};

fiecare pachet InSim începe cu un antet, format din 4 octeți. Primul octet este dimensiunea pachetului, urmat de tipul de pachet din enumerarea ISP_ și apoi ReqI (în picioare pentru ID-ul cererii). Ori de câte ori se face o cerere către LFS, valoarea ReqI trebuie setată la zero, prin care LFS va răspunde cu aceeași valoare setată în reqi a pachetului solicitat. În cele din urmă, al patrulea octet variază în funcție de tipul de pachet în cauză, care în acest caz este gol.

după cum puteți vedea pachetul IS_ISI conține diferite opțiuni și steaguri care sunt utilizate la inițializarea sistemului InSim. Trebuie să împachetăm aceste date într-un șir formatat binar pentru a le trimite la 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)

primirea datelor

după crearea conexiunii și inițializarea InSim, trebuie să configurăm bucla de primire a pachetului. Deoarece datele în modul TCP sunt trimise ca un flux constant de date, mai multe pachete pot ajunge într-un singur apel de primire și unele pachete pot ajunge incomplete. Aceasta înseamnă că trebuie să stocăm toate datele primite într-un tampon și apoi să citim fiecare pachet când suntem siguri că este complet.

# 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()

despachetarea pachetelor

odată ce am primit datele de pachete ca șir formatat binar, trebuie să despachetăm aceste date într-un format care ne este util. În exemplul nostru anterior când am trimis pachetul de inițializare IS_ISI, am setat ReqI la zero, ceea ce înseamnă că LFS a răspuns cu un pachet de versiune IS_VER, cu toate acestea nu am făcut nimic cu el. În primul rând vă permite să se uite la definiția pentru pachetul IS_VER de la 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};

acum să ne uităm la modul în care am despacheta aceste date în Python.

# 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

pentru a menține conexiunea deschisă, LFS va trimite un pachet „keep alive” la fiecare 30 de secunde. Acest pachet este un IS_TINY cu un SubT (sub-Tip) de TINY_NONE. Trebuie să răspundem la acest pachet de fiecare dată când este primit pentru a împiedica sincronizarea conexiunii cu 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)

alte exemple

puteți vedea exemplul complet al acestui cod, precum și altele pe pagina de exemple InSim.

biblioteci InSim

desigur, așa cum spune vechea zicală, nu ar trebui să încercați să reinventați roata (cu excepția cazului în care încercați să aflați mai multe despre roți) și există mai multe biblioteci InSim mature disponibile pentru utilizare în propriul cod.

referința InSim

Iată o încercare de a face referire la Protocolul InSim complet.