[MOD/API] X4RestServer - External http API

[Cadbury]

How did you get it running on Linux? I'm using the steam version and have followed the instructions but the game never starts. I can see the process running but it's not doing anything and no window appears

If I run the exe without the LD_PRELOAD, it still doesn't start which makes me think it's something about the steam exe that's causing issues (when steam isn't running).

[beko]

How did you get it running on Linux? I'm using the steam version and have followed the instructions but the game never starts. I can see the process running but it's not doing anything and no window appears

Not so easy with Steam. I'm running the GOG version and I'm starting it just like that after the lib was compiled:

Code: Select all

LD_PRELOAD="${LD_PRELOAD}:/games/linux/X4_Foundations/game/lib/X4RestServer.so" ./X4 -skipintro

I did move the lib into the game lib folder though. Game starts fine and the server is raised on port 3000 (hint: 0.0.0.0 is free for all, anyone on the net/wlan can talk to this now and break your game)

Code: Select all

beko  ~  lsof -i tcp:3000
COMMAND   PID USER   FD   TYPE DEVICE SIZE/OFF NODE NAME
Main()  73073 beko    5u  IPv4 517725      0t0  TCP *:hbci (LISTEN)

YOU will probably have to set the Steam start options so something like this (don't hold me to that - not so firm with Steam)

Code: Select all

LD_PRELOAD="/path/to/X4RestServer.so" %command% -skipintro 

The FFIRipper is giving me some trouble but that's not required to talk to the server from my understanding. It just builds the references for available FFI stuff. Postponed - playing with the server is way more fun right now

[beko]

I'm having way too much fun with this. Did some plumbing today and this is the result


Short screen recording: https://beko.famkos.net/2021/05/02/auto-draft/
The flight instruments are from https://github.com/uw-ray/Skyhawk-Flight-Instruments and are not for a spaceship - obviously

I patched the http server to send Access-Control-Allow-Origin so the browser wouldn't refuse to load. Could set up a proxy but I wanted results fast

* Speed is also mapped to ALT as Fast Travel speed
* It reads just the camera position and not really the ship position (and since there is no up and down in space it settles fast on the new artificial horizon - may need some more tuning)
* Plumbed the speed to the pressure so it starts creeping up from 27.1 inHg to 33 inHg (max on the instrument) when speed goes over 200. Just for fun.
* Turn Coordinator is just Camera yaw + left or right based on mouse/pointer X.
* Some target data as proof of concept

This worked out better than expected and the best thing is: Doesn't need to run on the same computer - it just has to be on the net so a tiny Raspberry and some external display would be enough for some fun cockpit building

[kuertee]

nice!

[Mycu]

I'm having way too much fun with this. Did some plumbing today and this is the result

Great that you found this project and nice results so far.
I can't wait to see where this gets to. So many possibilities.

[Mamy la Puce]

How could I use this mod to know some data like for example if the player is on foot or at the controls of a ship, if he take off from the station (or ship docking deck) or is he still docked ? My goal is to be able to use this "feedback" to set up my VoiceAttack profile and that’s typically what I’m looking for !! Does your mod inform about this kind of thing in a text (.json) file ? If so, where can I find this file ?

Here is my Request on the forum : viewtopic.php?f=146&t=439757

[beko]

How could I use this mod to know some data like for example if the player is on foot or at the controls of a ship, if he take off from the station (or ship docking deck) or is he still docked ? My goal is to be able to use this "feedback" to set up my VoiceAttack profile and that’s typically what I’m looking for !! Does your mod inform about this kind of thing in a text (.json) file ? If so, where can I find this file ?

It's providing various documented functions via a REST route returning data as json. This means once running you have to request the data you need via http from the server probably running on localhost. This is described on the project page. You basically have to query the information of interest and poll that information in a loop.

Here is an example to poll for the PlayerShipID in JS:

Code: Select all

        var server =  'http://localhost:3000/';
        var shipID = 0;
        setInterval(function() {
            fetch(`${server}GetPlayerShipID`).then((r) => r.json())
            .then((data) => {
                if(data.func_res !== shipID){
                    console.log('ShipID changed', data.func_res);
                    shipID = data.func_res;
                }
            })
            .catch((e) => null)
        }, 2000);

(It's also an alpha version and a proof of concept - get's real crash happy for me after some time)

[Mamy la Puce]

As you can see, i know nothing about coding, but i understand what it is for and yeah, it is what i was searching for ^^ Now i need to know, to learn how i can use it or find someone who could help me for that. It's a very good start to begin something around it in order to build VoiceAttack profiles like those from HCS Voices, having a "game feedback" is exactly what X4 needed for VA to do the same thing as for Elite Dangerous : build profiles around "Real Time Game Data Variables" !!

(sorry if my english is bad, not my first language)