th3r00t / sesocial-relay

Information relay client for spaceengineers server information. To be used with the Space Engineers Social project

• Version 0.1.0-prerelease
• Introduction
• Questions you'll never have to answer again.
  • You got a mod list I can look at?
  • Who plays on this server?
  • What factions are active here?
  • What's the economy like?
• Things I hope to see
  • Player wallets.
  • Improved in game economy, and resource trading system.
  • Faction GPS sharing.
  • Watchdog integration.
  • Visual Mapping.
  • Grid Registry.
  • Discord integration via web api for bot hooks.
• Howto
• Current State
  • Scraping
    • DONE server settings.
    • DONE player list.
    • DONE faction List.
    • DONE mod List.
    • DONE relative top speed settings.
    • player to faction link.
    • crunch econ data.
    • server grid list.
    • link grids to players.
  • Publishing
    • DONE publish server settings.
    • DONE publish player list.
    • DONE publish faction List.
    • DONE publish mod List.
    • publish player to faction link.
    • publish relative top speed settings.
    • publish crunch econ data.
    • publish server grid list.
    • publish link grids to players.
  • General
    • adjust rsync loop to guarantee no changes to the local files will be synced downstream.
• Project Goals
  • Scrape current information from servers sbc files
  • Store results
    • Put data in local sqlite database
    • Send data to remote database
• Open Source

Version 0.1.0-prerelease

Introduction

Space Engineers Social Relay Project is a project to create a social relay network for the game Space Engineers. The goal is to create a network of relays that can be used to send information from connected servers back to a centralized frontend.

Each relay will be a server that is connected to the game server and will be able to send information back to the frontend. The frontend will be a web application that will allow users to view information about the game servers and their players.

This is just the beginning of the project specification, and further features will be added as the project progresses.

Questions you'll never have to answer again.

You got a mod list I can look at?

sesocial-relay will provide a list of mods that are installed on the server. The front end will generate clickable links for all these mods.

Who plays on this server?

sesocial-relay will provide a list of players that are currently on the server, along with a history of who has played before.

What factions are active here?

sesocial-relay will provide a list of factions that are operating on your server.

What's the economy like?

sesocial-relay will provide a list of all the items that are being traded via crunch economy.

Things I hope to see

Player wallets.

Gateway feature to hopefully integrate with a full blown economy system.

Improved in game economy, and resource trading system.

Out of game digital marketplace for trading in game resources and setting up said trades.

Faction GPS sharing.

Drop a gps marker, and have it listed on your factions page, for your memebers to see.

Watchdog integration.

A watchdog integration to allow for a more robust and reliable way to monitor your server. The framework for this integration is already in place, but it needs to be fleshed out.

Visual Mapping.

think general galactic overview things like planets, & other celestial objects. Trade stations etc…

Grid Registry.

All grids are listed in your servers sbc file, lets do something with them. Label them, store them, back them up independently of the server.

Discord integration via web api for bot hooks.

This is almost as simple as setting up a quick set of FastAPI endpoints, This could be done either here in the relay or upstream on the frontend.

Howto

During the initial development phase, the project will be developed in a way where the aggregated data will be stored in a local database. Conversly the data being scraped is currently setup with a rsync driven file fetching system.

It is not expected that actual deployment of the relay post development will be done in this manner, but it is a good way to get started. Seemingly as a biproduct of this, the files being scraped are not the same as the files in use by the game server. The work is being done on copies of the files. Which should by virtue of rsync be guaranteed to be latest availavle version.

Current State

Scraping

DONE server settings.

DONE player list.

DONE faction List.

DONE mod List.

DONE relative top speed settings.

TODO player to faction link.

TODO crunch econ data.

TODO server grid list.

TODO link grids to players.

Publishing

DONE publish server settings.

DONE publish player list.

DONE publish faction List.

DONE publish mod List.

TODO publish player to faction link.

TODO publish relative top speed settings.

TODO publish crunch econ data.

TODO publish server grid list.

TODO publish link grids to players.

General

TODO adjust rsync loop to guarantee no changes to the local files will be synced downstream.

Project Goals

Scrape current information from servers sbc files

Decoupled from the existing server tech, it is it's own daemon

Store results

DONE Put data in local sqlite database

TODO Send data to remote database

• VERIFY Using sqlalchemy this should be as simple as updating the engine creation routine.

Open Source

The relay is now, and will remain an opensource project. The source code is hosted on github. The frontend is closed source, and will be hosted free for all to use once it is ready for public use at (yourserver).spaceengineers.social.

With the relay being opensource, and since it does all the real work of interpreting the data others are encouraged to contribute to the project. If you are interested in helping out, please contact me on my discord server at discord.gg/H9TbNJS.