lfs_insim

A Python library for the Live for Speed InSim protocol: InSim (TCP), OutSim and OutGauge (UDP). Plain import, no framework, no dependencies.

Status: alpha. The library is checked against a real LFS (0.8C), but its API may still change before 1.0.

• Python 3.11 or newer, no dependencies, fully typed.
• Every packet class is generated from the official specification published at lfs.net, so the fields are named exactly as in InSim.txt.
• Handlers with decorators, await insim.request(...), chat commands, a roster of connections and players, and automatic reconnection if LFS restarts.

Install

pip install lfs-insim

A first program

In LFS, type /insim=29999 to let it listen for InSim. Then run this and type !hello in the game:

from lfs_insim import Command, InSim
from lfs_insim.packets import IS_VER

insim = InSim(name="hello", prefix="!")  # admin_password="..." if LFS has one


@insim.on(IS_VER)
def connected(packet: IS_VER) -> None:
    print(f"Connected to LFS {packet.Version}, InSim {packet.InSimVer}")


@insim.on_command("hello")
def hello(command: Command) -> None:
    command.reply("Hello from Python")


if __name__ == "__main__":
    insim.run()  # blocks until Ctrl+C; reconnects on its own if LFS restarts

What is in the box

The guide is in docs/. Short, runnable programs are in examples/: hello.py, who.py, buttons.py and gauge.py.

Development

This repository is worked on with the notes in docs/dev (in Spanish). To check everything: python scripts/verify.py.

License

MIT — see LICENSE.