From f27bdbfdc449c524293620f1382683e39a218028 Mon Sep 17 00:00:00 2001 From: CSK <73425927+cr2007@users.noreply.github.com> Date: Sat, 5 Mar 2022 09:49:32 +0400 Subject: [PATCH 1/3] Adds an Index for easier access to the different parts 1. Adds an alt text for the WebRTC demo image 2. Minor edits to the file for easier readibility across the README file --- README.md | 40 ++++++++++++++++++++++++++++++---------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 348842d..d82ea84 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,30 @@ accepting remote inputs. There will be ansible instructions which can be executed inside into any virtual environment. This will be a plugin which complements the project [P2PRC](https://p2prc.akilan.io) -## Testing with Xplane 11 -[![IMAGE ALT TEXT](https://i.ytimg.com/vi/65dn7TRgzeE/hqdefault.jpg)](https://www.youtube.com/watch?v=65dn7TRgzeE "Running Xplane 11 using WebRTC") +# Index + +- [Testing with X-Plane 11](#testing-with-x-plane-11) +- [Laplace](#laplace) +- [Installation](#installation) + - [Installation required to share keyboard and mouse](#installation-required-to-share-keyboard-and-mouse) + - [What is x2x?](#what-is-x2x) + - [What is Barrier KVM](#what-is-barrier-kvm) + - [Barrier KVM build status and links to install](#barrier-kvm-build-status-and-links-to-install) + - [Build from Source](#build-from-source) +- [Program Execution](#program-execution) + - [Starting game when screen-share is triggered](#starting-game-when-screen-share-is-triggered) + - [Ex: Start X-Plane 11](#ex-start-x-plane-11) + - [Open config file](#open-config-file) + - [Call from built script which starts the server , creates room and outputs the ID](#call-from-built-script-which-starts-the-server--creates-room-and-outputs-the-id) + - [Starting the Server](#starting-server) + - [Starting the Screenshare](#starting-screenshare) +- [Contributing](#contributing) +- [Discord Server Link](#or) + +--- + +## Testing with [X-Plane 11](https://www.x-plane.com/) +[![A screenshot of X-Plane 11 (flight simulator game) running smoothly via WebRTC](https://i.ytimg.com/vi/65dn7TRgzeE/hqdefault.jpg)](https://www.youtube.com/watch?v=65dn7TRgzeE "Running X-Plane 11 using WebRTC") ## Laplace Based on the fork: @@ -28,12 +50,12 @@ Currently, you can either use [x2x](https://github.com/dottedmag/x2x) or [Barrie We need to ensure that the client has SSH client installed or Barrierc. #### What is x2x? -x2x allows the keyboard, mouse on one X display to be used to control another X +[x2x](https://github.com/dottedmag/x2x) allows the keyboard, mouse on one X display to be used to control another X display. It also shares X clipboards between the displays. Note: x2x runs on top of SSH. -#### What is Barrier kvm? +#### What is Barrier KVM? Barrier 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 @@ -89,7 +111,7 @@ go build . # Open config.json file and add SSH password for x2x ``` -### Program Execution +## Program Execution Executing this project basically serves an HTTP server that will host the frontend and the WebSocket implementation. Note that you sometimes need to run HTTPs in order for browser to connect to websocket. @@ -124,13 +146,13 @@ with barrier KVM. Run as non-root. ### Starting game when screen-share is triggered This requires creating a bash script to trigger when the screenshare begins. -#### Ex: Start Xplane 11 +#### Ex: Start X-Plane 11 Let's call this script xplane11.sh ```bash -# Navigating to the directory where XPlane11 is present +# Navigating to the directory where X-Plane11 is present cd /path/.local/share/Steam/steamapps/common/X-Plane\ 11/ -# Execute Xplane 11 binary +# Execute X-Plane 11 binary ./X-Plane-x86_64 ``` #### Open config file @@ -175,5 +197,3 @@ Pull requests are welcome. For major changes, please open an issue first to disc ### or [![Support Server](https://discordapp.com/api/guilds/854397492795277322/widget.png?style=banner2)](https://discord.gg/b4nRGTjYqy) - - From d09ff757cfc3d2195ab1410bef646a90d33272c2 Mon Sep 17 00:00:00 2001 From: CSK <73425927+cr2007@users.noreply.github.com> Date: Sun, 6 Mar 2022 07:48:30 +0400 Subject: [PATCH 2/3] Another minor addition --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d82ea84..528b2c1 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,7 @@ with barrier KVM. Run as non-root. ### Starting game when screen-share is triggered This requires creating a bash script to trigger when the screenshare begins. #### Ex: Start X-Plane 11 -Let's call this script xplane11.sh +Let's call this script `xplane11.sh` ```bash # Navigating to the directory where X-Plane11 is present cd /path/.local/share/Steam/steamapps/common/X-Plane\ 11/ From b74a1e729a74449ad281cb33c132c0fa22962da7 Mon Sep 17 00:00:00 2001 From: CSK <73425927+cr2007@users.noreply.github.com> Date: Sun, 6 Mar 2022 07:53:10 +0400 Subject: [PATCH 3/3] Adds `
` tag to put the text in the next line Easier to read rather than as a huge paragraph --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 528b2c1..e8e7f06 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![made-with-Go](https://img.shields.io/badge/Made%20with-Go-1f425f.svg)](http://golang.org) The aim of this project is develop a WebRTC screenshare designed for streaming video games and -accepting remote inputs. +accepting remote inputs.
There will be ansible instructions which can be executed inside into any virtual environment. This will be a plugin which complements the project [P2PRC](https://p2prc.akilan.io) @@ -46,7 +46,7 @@ https://github.com/Akilan1999/laplace/tree/keyboard_mouse ### Installation required to share keyboard and mouse -Currently, you can either use [x2x](https://github.com/dottedmag/x2x) or [Barrier KVM]() +Currently, you can either use [x2x](https://github.com/dottedmag/x2x) or [Barrier KVM]()
We need to ensure that the client has SSH client installed or Barrierc. #### What is x2x? @@ -113,7 +113,7 @@ go build . ## Program Execution -Executing this project basically serves an HTTP server that will host the frontend and the WebSocket implementation. +Executing this project basically serves an HTTP server that will host the frontend and the WebSocket implementation.
Note that you sometimes need to run HTTPs in order for browser to connect to websocket. ```bash @@ -140,7 +140,7 @@ $ ./laplace --help Use TLS ``` -By default, you can run the executable without any argument to listen to TLS port 443. +By default, you can run the executable without any argument to listen to TLS port 443.
A self-signed certificate files are provided to ease up development. If you want to run with barrier KVM. Run as non-root. @@ -171,7 +171,7 @@ cd /path/.local/share/Steam/steamapps/common/X-Plane\ 11/ ```bash sh run.sh ``` -Note: This script starts the server using the port 8888 by default +Note: This script starts the server using the port 8888 by default
The 2 steps below are if you want to start them command by command ### Starting server @@ -185,7 +185,7 @@ $ ./laplace -tls -addr 0.0.0.0:8888 ./laplace -headless -addr ``` -You can then open https://localhost:8888/ to view Laplace page. +You can then open https://localhost:8888/ to view Laplace page.
You may need to add certificate exceptions. In Chrome, you can type `thisisunsafe`.