InSim

InSim

az InSim egy olyan protokoll, amely lehetővé teszi egy külső program számára, hogy élőben kommunikáljon a sebesség érdekében. Ez lehetővé teszi, hogy hozzon létre egy socket kapcsolatot a játékot, és küldeni és fogadni adatcsomagokat. Az InSim protokoll leírja, hogyan formázza ezeket a csomagokat, és minden olyan programozási nyelv, amely képes hálózati kapcsolatot létrehozni, és bináris adatokat küldeni és fogadni.

a hivatalos dokumentációt az InSim fájl tartalmazza.txt, a games doc mappában található. Ez egy C++ fejlécfájlból áll, amely tartalmazza az egyes csomagok meghatározását, valamint a Scawen megjegyzéseit, hogy hogyan kell használni őket. Az itt található dokumentáció ennek a fájlnak a kiegészítője.

UDP vs TCP

az InSim támogatja mind az UDP, mind a TCP kapcsolatokat. UDP módban csak egyetlen kapcsolat hozható létre, azonban legfeljebb nyolc kapcsolat hozható létre a játékkal a TCP-ben. Függetlenül attól, hogy TCP-ben vagy UDP-ben csatlakozik-e, megadhat egy külön UDP-aljzatot az autó pozíciófrissítéseinek fogadásához, például az IS_MCI és az IS_NLP.

InSim example

az InSim kapcsolat létrehozásának módja természetesen attól függ, hogy melyik programozási nyelvet használja, de itt megkíséreljük dokumentálni a folyamatot néhány példával a népszerű Python programozási nyelvből. Mint fentebb említettük, minden olyan nyelv, amely képes socket-kapcsolatot létrehozni, felhasználható az LFS-hez való csatlakozásra, azonban az elv ettől függetlenül ugyanaz marad.

kapcsolat létrehozása

először is létre kell hoznunk egy socket kapcsolatot a játékkal, ebben az esetben a TCP-ben.

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

inicializálás az InSim

a kapcsolat létrehozása után inicializálnunk kell az InSim rendszert az IS_ISI csomag elküldésével. Mielőtt ezt megtehetnénk, először meg kell intitailse InSim belül LFS magát. Ehhez indítsa el a játékot, és írja be a “/insim 29999″csevegési parancsot. A használt portszám bármilyen érvényes port lehet, de általában a 29999 az elfogadott alapértelmezett.

itt található az Is_isi csomag meghatározása az InSim-től.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};

minden InSim csomag 4 bájtból álló fejléccel kezdődik. Az első bájt a csomag mérete, majd az ISP_ enumerációból származó csomag típusa, majd a ReqI (request Id). Amikor az LFS-hez kérés érkezik, a ReqI értékét nem nullára kell állítani, ahol az LFS a kért csomag ReqI-jében beállított értékkel válaszol. Végül a negyedik bájt a kérdéses csomag típusától függően változik, amely ebben az esetben üres.

mint látható, az IS_ISI csomag különböző opciókat és jelzőket tartalmaz, amelyeket az InSim rendszer inicializálásakor használnak. Ezeket az adatokat bináris formázott karakterláncba kell csomagolni, hogy elküldjük az LFS-nek.

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

adatok fogadása

a kapcsolat létrehozása és az InSim inicializálása után be kell állítanunk a csomagfogadási ciklust. Mivel a TCP módban az adatok állandó adatfolyamként kerülnek elküldésre, több csomag is érkezhet egyetlen vételi hívásban, egyes csomagok pedig hiányosak lehetnek. Ez azt jelenti, hogy az összes bejövő adatot pufferben kell tárolnunk, majd minden csomagot Ki kell olvasnunk, amikor biztosak vagyunk benne, hogy teljes.

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

csomagok kicsomagolása

miután megkaptuk a csomagkapcsolt adatokat bináris formázott karakterláncként, akkor ezeket az adatokat olyan formátumba kell kicsomagolnunk, amely hasznos számunkra. Előző példánkban, amikor elküldtük az IS_ISI initailisation csomagot, a ReqI-t nem nullára állítottuk, ami azt jelenti, hogy az LFS IS_VER verziócsomaggal válaszolt, azonban nem tettünk vele semmit. Először nézzük meg az Is_ver csomag definícióját az InSim-től.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};

most nézzük meg, hogyan szeretnénk kicsomagolni, hogy az adatok 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

a kapcsolat nyitva tartása érdekében az LFS körülbelül 30 másodpercenként küld egy “keep alive” csomagot. Ez a csomag egy IS_TINY egy SubT (altípusa) a TINY_NONE. Minden alkalommal válaszolnunk kell erre a csomagra, amikor beérkezik, hogy megakadályozzuk az InSim-mel való kapcsolat időzítését.

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

további példák

a kód teljes példáját az InSim példák oldalon láthatja.

InSim könyvtárak

természetesen a régi mondás szerint nem szabad megpróbálnod újra feltalálni a kereket (hacsak nem akarsz többet megtudni a kerekekről), és számos érett InSim könyvtár áll rendelkezésre a saját kódodban.

InSim Reference

itt egy kísérlet a teljes InSim protokoll hivatkozására.