Server-side URNET Monitoring Client

daveseah commented 8 months ago

Until now, there has been no need for a server-side client for The URNET message system, but the need has arisen in Issue #778 "Game State Subscriptions Via External Websockets". As noted in the issue, they have been processing the text log files but this quickly becomes unwieldy.

This PR is a stripped-down version of URSYS that connects to the current AppServer and intercepts NET:DISPLAY_LIST directly. It is a self-contained proof-of-concept that currently lives in gsgo/gs_packages/gem-srv/urnet-peek, and it's invoked from the root gsgo directory with npm run urpeek.

This is a work-in-progress and has not been fully tested or hardened for robust operation. If this seems to meet the needs of the AI Team we can allocate time to make it more useful based on feedback.

IMPACT ON CURRENT CODE

The additions in this pull request are completely independent from any other code, and can be used standalone by copying the gem-srv/urnet-peek folder to another location. I probably should make sure it has its own package.json and .nvmrc

TRYING IT OUT

Assuming you have already installed GEMSTEP and have a running version of it, do the following on the host computer:

npm run gem and open a MAIN and CONTROLLER
In a second terminal, npm run urpeek You should see entity counts appearing in the second terminal.

README

There's a README.md file in gem-srv/urnet-peek with more information about the operation of URNET itself and how to work with this chunk of code

daveseah commented 7 months ago

Joshua reported in Slack:

update from the VU team: "I wanted to give you a quick status update on our tests. So far we’ve been able to successfully capture different types events in a couple of models using the functions available on urnet-peek/peek.js. Today we will stress-test playing with more tags to make sure increased data flow is properly handled and write a python client on the pipeline."

So I'm removing the WIP and this can be merged into gemstep officially

daveseah commented 7 months ago

Assigning @benloh the honors of merging while he's updating the other branches! :)

theRAPTLab / gsgo