InSim

InSim

InSimは、外部プログラムがLiveと通信して速度を上げることを可能にするプロトコルです。 それはあなたがゲームとのソケット接続を作成し、データのパケットを送受信することができます。 InSimプロトコルは、これらのパケットのそれぞれがどのようにフォーマットされるかを記述し、ネットワーク接続を作成し、バイナリデータの文字列を送受信することができる任意のプログラミング言語は、それとインターフェイスすることができます。

公式文書はInSimファイルに含まれています。txt、ゲームのdocフォルダにあります。 これは、各パケットの定義を含むC++ヘッダーファイルと、それぞれがどのように使用されるべきかについてのScawenからのコメントで構成されています。 ここでのドキュメントは、このファイルの補助として意図されています。

UDPとTCP

InSimはUDPとTCPの両方の接続をサポートしています。 UDPモードでは、1つの接続のみを作成できますが、TCPでは最大8つの接続をゲームに作成できます。 TCPで接続されているかUDPで接続されているかにかかわらず、IS_MCIやIS_NLPなど、車の位置の更新を受信するための別のUDPソケットを指定することがで

InSim example

InSim接続を作成する方法はもちろん、使用しているプログラミング言語に依存しますが、ここでは一般的なPythonプログラミング言語のいくつかの例 上記のように、ソケット接続を行うことができる任意の言語は、LFSとのインタフェースに使用することができますが、原則は関係なく同じままです。

接続の作成

まず、この場合は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))

InSimの初期化

接続を確立した後、IS_ISIパケットを送信してInSimシステムを初期化する必要があります。 しかし、これを行う前に、まずLFS自体の中でIntitailse InSimする必要があります。 これを行うには、ゲームを開始し、チャットコマンド”/insim29999″を入力します。 使用されるポート番号は任意の有効なポートにすることができますが、一般的には29999が受け入れられるデフォルトになる傾向があります。

InSimからのIS_ISIパケットの定義は次のとおりです。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};

各InSimパケットは、4バイトで構成されるヘッダーで始まります。 最初のバイトはパケットのサイズであり、その後にISP_列挙からのパケットタイプが続き、次にReqI(要求Idを表す)が続きます。 ＬＦＳに対して要求がなされるたびに、Ｒｅｑｉの値はゼロ以外に設定されなければならず、それにより、ＬＦＳは、要求されたパケットのＲｅｑｉに設定された同じ値で応答 最後に、4番目のバイトは、問題のパケットのタイプに応じて異なりますが、この場合は空白です。

ご覧のように、Is_ISIパケットには、InSimシステムを初期化するときに使用されるさまざまなオプションとフラグが含まれています。 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)

受信データ

接続を作成し、InSimを初期化した後、パケット受信ループを設定する必要があります。 TCPモードのデータは一定のデータストリームとして送信されるため、単一の受信コールで複数のパケットが到着し、一部のパケットが不完全に到着する可能性 つまり、すべての受信データをバッファに格納し、完了したことが確認されたら各パケットを読み出す必要があります。

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

Unpacking Packets

パケットデータをバイナリ形式の文字列として受け取ったら、このデータを便利な形式に解凍する必要があります。 前の例では、IS_ISI initailisationパケットを送信したときに、ReqIを非ゼロに設定しました。 まず、InSimからのIS_VERパケットの定義を見てみましょう。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};

ここで、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

接続を開いたままにするために、LFSは30秒ほどごとに”keep alive”パケットを送信します。 このパケットは、TINY_NONEのSubT(sub-type)を持つIS_TINYです。 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)

その他の例

このコードの完全な例とその他の例をInSimの例ページで見ることができます。

InSim Libraries

もちろん、古い格言が行くように、あなたは（あなたが車輪についての詳細を学ぼうとしていない限り）ホイールを再発明しようとすべきではな

InSimリファレンス

ここでは、完全なInSimプロトコルを参照しようとしています。

を押します