Node InSim

Introducing Node InSim, an InSim library for Node.js with Typescript support.

At Sim Broadcasts, we are big advocates of the Web and open-source software. We wanted to develop a Node.js based InSim implementation to complement our own technology stack and to contribute something useful back to the community.

Node InSim is compatible with InSim version 9.

Installation

Install the node-insim NPM package in your Node.js application:


or if you use Yarn:


Basic Usage

To connect to an LFS server, you must enter its hostname, a port and a short name for your application.

The InSim port must be configured in the LFS server settings. Also, make sure the public IP address from which your application is connecting is allowed to connect to the server InSim port.

Quote from Basic Node InSim Usage: github.com/simbroadcasts/node-insim :

import { InSim } from 'node-insim';

const inSim = new InSim();

inSim.connect({
Host: '127.0.0.1',
Port: 29999,
IName: 'Node InSim App',
});

Begin developing with Node InSim

To learn more, including how to send and receive packets with Node InSim, check out the Node InSim repository on GitHub.

Version 0.10.0 released now with full OutSim support. Thanks to xspeedasx for OutSimPack2 support

Here's a demonstration video of what output can be obtained from the full OutSim packet:



OutSim code examples:
Basic (OutSimPack)
Advanced (OutSimPack2 with all options enabled)

How did you run LFS on a macOS? can you make a guide?

Quote from racerss :

How did you run LFS on a macOS? can you make a guide?

https://www.codeweavers.com/crossover/ is the easiest. Will run 32 bit apps as well as run on Intel or Apple Silicon.

If you know, you can use homebrew to install Crossover's fork of Wine.

https://gist.github.com/doole/063319903a09bfd4954872d73652d0a2#wine-crossover

This is a guide. You don't need to create the 32 bit prefix.

I use PlayOnMac: https://www.playonmac.com/en/

Quote from Flame CZE :

I use PlayOnMac: https://www.playonmac.com/en/

As you know, I tried this on Apple silicon, and it didn't work so well with LFS. I'm going to try Dustin's suggestions above.

Quote from mbutcher :

As you know, I tried this on Apple silicon, and it didn't work so well with LFS. I'm going to try Dustin's suggestions above.

It'll be the same. I gave it a try thinking things improved but it's the same on my M1 Pro as before.

Annoyingly, you might get better perf in Parallels (VMWare doesn't yet support 3D). I tried it a year back but I don't have an active Parallels subscription now.

I tried the free trial, and yeah, it doesn't work.

Since the test patch D50 introduced a few InSim updates, I've prepared a pull request to implement them in Node InSim.

Main additions:

License property added to IS_NCI packet
IS_PLH packet which sets handicaps for individual players
TINY_PLH subtype of IS_TINY to request IS_PLH listing player handicaps
SMALL_LCL subtype of IS_SMALL - full control of lights including fog and extra lights
Example app using OutGauge with InSim buttons
New dashboard lights in DashLights enum of OutGaugePack

Full list of changes in the PR: https://github.com/simbroadcasts/node-insim/pull/28

No matter what I did, I couldn't get it to work. Can you please explain step by step when you can?

What did you try to run it?

I've simplified the example apps now - you can check them out in the examples folder. They're also listed in the README. The simplest example is "InSim connection".

You can also use one of these standalone demo applications I've prepared:
- JavaScript: https://github.com/mkapal/node-insim-demo
- TypeScript: https://github.com/mkapal/node-insim-demo-typescript

You can clone the repository and run it on your computer. You need Node.js to run it.

Hello Flame CZE! After not being able to do it, I got angry and stopped dealing with these things, but I'm still curious. Can you write me a simple code that can turn on and off the lights of the car so that I can understand the basics? It can be with a button or a command.

You can control local car lights by sending an IS_SMALL packet with a SubT of SmallType.SMALL_LCL. For example, to turn the high beam on, you send this packet:

Handling commands is done by setting the command prefix character in the inSim.connect() method config and then listening for the IS_MSO packet.

I have created a demo application where you can type !lights on or !lights off to toggle the car's high beam. You can check the full source code at github.com/mkapal/node-insim-car-lights-example. The main program code is in index.ts. Feel free to clone the repository, follow the instructions in the README file and see if it works for you.

Version 4.2.1 is out with the new IS_IPB packet introduced in LFS 0.7F.

Only plain IPv4 strings are supported for now, but if there's demand for more advanced conversion/parsing, feel free to give feedback.

The IP strings go through validation before the packet is sent. If it's not a valid IPv4, a RangeError will be thrown.

Set new IP bans:


Request all IP bans:

There is a new documentation page, which is auto-generated from all public API:

https://simbroadcasts.github.io/node-insim/

v4.3.0 introduces a new API for sending messages - no more trying to remember which packet to send

Send a message which will appear on the local computer only (IS_MSL):


Starts with a slash - send an IS_MST packet:


Up to 63 characters - send an IS_MST packet:


64 characters or more - send an IS_MSX packet:


Send a message to a specific connection by their UCID (IS_MTC):


Send a message to a specific player by their PLID (IS_MTC):