InSim

InSim

InSim on protokolla, jonka avulla ulkopuolinen ohjelma voi kommunikoida Liven kanssa nopeuden vuoksi. Sen avulla voit luoda socket-yhteyden peliin ja lähettää ja vastaanottaa datapaketteja. InSim-protokolla kuvaa, miten kukin näistä paketeista on muotoiltu, ja mikä tahansa ohjelmointikieli, joka voi luoda verkkoyhteyden ja lähettää ja vastaanottaa binääridatan merkkijonoja, voi liittyä siihen.

virallinen asiakirja sisältyy InSim-asiakirjavihkoon.txt, löytyy pelit doc-kansiosta. Se koostuu C++ – otsikkotiedostosta, joka sisältää kunkin paketin määritelmän sekä scawenin kommentit siitä, miten kutakin tulisi käyttää. Tässä oleva dokumentaatio on tarkoitettu tämän tiedoston liitännäiseksi.

UDP vs TCP

InSim tukee sekä UDP-että TCP-yhteyksiä. UDP-tilassa voi tehdä vain yhden yhteyden, mutta TCP: ssä peliin voi saada jopa kahdeksan yhteyttä. Olipa kytketty TCP tai UDP, on mahdollista määrittää erillinen UDP-pistorasia vastaanottaa auton sijainti päivitykset, kuten IS_MCI ja IS_NLP.

InSim-esimerkki

miten teet InSim-yhteyden, riippuu tietenkin siitä, mitä ohjelmointikieltä käytät, mutta tässä yritämme dokumentoida prosessia muutamilla esimerkeillä suositusta Python-ohjelmointikielestä. Kuten edellä mainittiin, mikä tahansa kieli, joka pystyy tekemään socket-yhteyden, voidaan käyttää käyttöliittymään LFS: n kanssa, mutta periaate pysyy samana riippumatta.

yhteyden luominen

ensin on luotava pistokeyhteys peliin, tässä tapauksessa TCP: hen.

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

InSim-järjestelmän alustaminen

yhteyden muodostamisen jälkeen meidän on alustettava InSim-järjestelmä lähettämällä is_isi-paketti. Ennen kuin voimme tehdä tämän kuitenkin meidän on ensin intitailse InSim sisällä LFS itse. Voit tehdä tämän aloittamalla pelin ja antamalla chat-komennon ”/ insim 29999”. Käytetty portin numero voi olla mikä tahansa kelvollinen portti, mutta 29999 on yleensä hyväksytty oletusarvo.

tässä on määritelmä Is_isi-paketille Insimistä.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};

jokainen InSim-paketti alkaa otsikolla, joka koostuu 4 tavusta. Ensimmäinen tavu on paketin koko, jota seuraa paketin tyyppi isp_-arvojoukosta ja sitten reqi (request Id). Kun LFS: lle esitetään pyyntö, ReqI-arvon on oltava muu kuin nolla, jolloin LFS vastaa samalla arvolla, joka on asetettu pyydetyn paketin ReqI-arvoon. Lopuksi neljäs tavu vaihtelee riippuen kyseisen paketin tyypistä, joka tässä tapauksessa on tyhjä.

kuten näette, is_isi-paketti sisältää erilaisia vaihtoehtoja ja lippuja, joita käytetään InSim-järjestelmän alustamisessa. Meidän on pakattava nämä tiedot binäärimuotoiseen merkkijonoon lähettääksemme ne LFS: lle.

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

tietojen vastaanottaminen

yhteyden luomisen ja InSim-alustuksen jälkeen meidän on sitten setup-paketti vastaanottaa silmukka. Koska tiedot TCP-tilassa lähetetään jatkuvana datavirtana, useita paketteja voi saapua yhdellä vastaanotetulla puhelulla ja jotkut paketit voivat saapua epätäydellisinä. Tämä tarkoittaa, että meidän on tallennettava kaikki saapuvat tiedot puskuriin ja luettava jokainen paketti, kun olemme varmoja, että se on valmis.

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

pakkausten purkaminen

kun olemme saaneet paketin tiedot binäärimuotoisena merkkijonona, meidän on purettava nämä tiedot meille hyödylliseen muotoon. Edellisessä esimerkissämme, kun lähetimme IS_ISI initailisation-paketin, asetimme reqi-arvon ei-nollaan, mikä tarkoittaa, että LFS vastasi is_ver-versiopaketilla, mutta emme tehneet mitään sen kanssa. Ensinnäkin katsotaanpa määritelmä is_ver paketti 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};

nyt katsotaan, miten purkaisimme tuon tiedon Pythonissa.

# 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

pitääkseen yhteyden auki LFS lähettää ”keep alive” – paketin noin 30 sekunnin välein. Tämä paketti on IS_TINY kanssa SubT (alatyyppi) TINY_NONE. Meidän on vastattava tähän pakettiin joka kerta, kun se vastaanotetaan, jotta estämme yhteyden Insimiin ajoituksen.

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

Lisäesimerkit

tämän koodin ja muiden Koko esimerkin näet InSim examples-sivulta.

InSim-kirjastot

vanhan sanonnan mukaan pyörää ei tietenkään kannata yrittää keksiä uudelleen (ellet yritä oppia lisää pyöristä), ja käytössä on useita kypsiä InSim-kirjastoja.

InSim-viittaus

tässä yritetään viitata täydelliseen InSim-pöytäkirjaan.