added docs for render machine

This commit is contained in:
2025-10-08 16:52:33 +01:00
parent 3729db43c0
commit 13932c2e58
3 changed files with 134 additions and 5 deletions

View File

@@ -133,3 +133,67 @@ is a high level function that encapsulates
#+END_SRC
Free the entire session created.
* Render machine
_Note: We do not talk about how the game_
_itself is deployed here and we assume that
the game is avaliable to execute._
This node is incharge of computing the game
in it's CPU and GPU. This layer does not
distinguish if the game is running bare-metal
or on a virtualised environment but rather
focuses on game itself is rendered and
is pass through the /user machine/. Xplane
is called using the binary.
locally on the machine and the instructions
relating to which window it's running is
_yet to be decided (This is considered a todo_).
This section is split into 3 parts:
- Streaming part
- Keyboard and mouse passthrough
- API layer
** Streaming part
The flight sim session is streamed using
WebRTC. We will initially hook a chromuim
browser to detect the screen and over time
reduce this to a simple screencapture
native program to stream the video feed.
_TODO: Specifics to be documented._
** Keyboard and mouse passthrough
We plan to maintain a open source fork
of InputLeap. Input Leap is software that
mimics the functionality of a KVM switch,
which historically would allow you to use
a single keyboard and mouse to control
multiple computers by physically turning
a dial on the box to switch the machine
you're controlling at any given moment.
Input Leap does this in software,
allowing you to tell it which machine to
control by moving your mouse to the edge
of the screen, or by using a keypress to
switch focus to a different system.
_TODO: Diagramtic explaination of setup._
** API layer
We use the Xplane API REST server and UDP calls
to transmit data back to the
/Instructor machine/ for further analyses
and controlling the flight scenarious.
We will implement our own wrapper on
top of the Xplane API to create standarised
controls no matter the version of the flight
sim and we can more fine system control
such as new scenery files to pull.
_TODO: Internal Xplane APIs to use, Extact routes_
_and relation to transmitted to the instructor server._
* Network of Scenery files
Not documented until mid 2026.